This documentation will describe how to install, remove, and uninstall GeoIPS plug-in packages after installing the core GeoIPS, including sections for Anaconda, PIP, expert install, developers, and Docker, all within one section.
Screenshots or terminal output examples for each installation method
Related Documentation
Installing Core GeoIPS
System Requirements
Best Practices
Tutorials
Conceptual Information
Contributing Section
Future Ideas
Scope of Documentation
Does NOT include
Description of how to use the plug-in packages
Description of what the plug-in packages do
Description of what the plug-in packages are
Description of the system requirements for the plug-in packages
Description of best practices for running the plug-in packages
Description of the architecture of GeoIPS
Does include
Instructions on how to install and remove/uninstall the plug-in packages
Links to more information about the plug-in packages
Links to the architecture of GeoIPS
Links to related tutorials and conceptual information sections
Links to the contributing section for making changes
Links to the future ideas section for potential changes in installation methods
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: June 3rd
Documentation Task
Files to be edited
Resources to be created
Related Documentation
Scope of Documentation
Checklist for Completion
./docs/build_docs.sh html_onlyto ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.main😊 with @biosafetylvl5 as a reviewer