Contribute to SPCC Database
---------------------------
.. warning::
Please note that we do not include narrowband filters. These highly specific
filters are synthesized in Siril, ensuring precision, which applies to
duonarrowband filters as well.
SPCC-Database JSON File Creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This tool helps you create SPCC-compatible JSON files from CSV data extracted using tools like https://apps.automeris.io/wpd4/.
.. raw:: html
📄 JSON File Creator
Upload CSV file with headers removed (as exported from wpd4)
Generated JSON:
SPCC-Database JSON File Validator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This validator allows you to detect and remove duplicate wavelength values in your JSON files.
.. raw:: html
🔍 JSON File Validator
Submitting Your Files
~~~~~~~~~~~~~~~~~~~~~
To add a new file to the database, we use the GitLab merge request (MR) process. Don't worry, it's simpler than it sounds! First, you'll need to create a `GitLab account `_ if you don't have one yet. Then, follow this quick step-by-step guide for beginners.
1. **Fork the repository**
Go to the `Siril SPCC Database GitLab page `_ and click the :guilabel:`Fork` button. This creates your own copy of the database that you can edit.
2. **Clone your fork**
Once you've forked the repository, clone it to your computer using this command in your terminal::
git clone https://gitlab.com/your-username/siril-spcc-database.git
Replace ``your-username`` with your actual GitLab username.
3. **Add your file**
Place your JSON file in the correct folder:
- ``mono_sensors/`` for monochrome sensors
- ``osc_sensors/`` for color sensors
- ``mono_filters/`` for monochrome filters
- ``osc_filters/`` for color filters
4. **Commit your changes**
After adding your file, commit the changes with the following commands::
git add .
git commit -m "Added data for [Your Sensor/Filter Name]"
5. **Push your changes**
Push the changes to your forked repository::
git push origin main
6. **Create a Merge Request**
Go back to the original repository on GitLab, and you'll see a button asking if you want to create a Merge Request. Click on it, review your changes, and submit the request. Our team will then review and merge your file into the main database!
.. note::
Please open a Merge Request for each new dataset added to facilitate easier review and ensure seamless integration. Thank you for your contributions!
Video Tutorial
~~~~~~~~~~~~~~
.. raw:: html