PlanetProfile documentation

This is the documentation for the code base of the PlanetProfile framework. The software is hosted on GitHub at https://github.com/vancesteven/planetprofile.

These pages are under construction.

Please refer to the README for the overall package description and quick start guide.

Contents:

• README
  • Acknowledging PlanetProfile
  • Getting started
    • For Python
      • Pip installation
      • Developers
    • For Matlab
  • Prerequisites
    • Note about SeaFreeze versions prior to v0.9.3
  • Installation of prerequisites
    • Python
    • Matlab
  • Uninstalling
  • Contributing
  • Notes
• PlanetProfile Python documentation
  • workspace
    • PlanetProfile package
      • CopyCarefully()
      • CopyOnlyIfNeeded()
      • RemoveCarefully()
      • Subpackages
      • Submodules
    • PlanetProfileCLI module

Indices and tables

• Index

• Module Index