Outline and provide guidance on the best practices for using GeoIPS in research and operational environments, including specific recommendations for static and dynamic sectors.
# Using GeoIPS for Research
- Explanation and guidance on leveraging GeoIPS for research purposes.
- Recommendations for configuration specific to research needs.
- Best practices for data analysis and processing in a research context.
# Using GeoIPS for Operations
- Recommendations configuration in operational environments.
- Guidance on maintaining and updating GeoIPS for operational efficiency.
## Static Sectors
- Definition of static sectors.
- Best practices for configuring for static sectors.
## Dynamic Sectors
- Definition of dynamic sectors.
- Best practices for configuring for dynamic sectors.
Checklist for Completion
[ ] Work done on a feature branch, eg. documentation-adding-functionality
[ ] Write the required documentation in RST.
[ ] Add any required resource files to a sub-folder.
[ ] Run ./docs/build_docs.sh html_only to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.
[ ] Update the relevant release notes.
[ ] Readable and followable writing, please use a grammar checker + spell checker.
[ ] Passes doc8 checks, see the sphinx RST Primer and checkout this black-like tool @biosafetylvl5 wrote for auto-formatting RST files: pink
[ ] A PR from your feature branch to main 😊 with @biosafetylvl5 as a reviewer.
Due on for review on: July 8th
Documentation Task
Files to be edited
docs/source/new-docs/getting-started/best-practices/index.rst
Resources to be created (optional)
Related Documentation
Scope of Documentation
Outline of Best Practices for Using GeoIPS
Checklist for Completion
./docs/build_docs.sh html_only
to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.main
😊 with @biosafetylvl5 as a reviewer.