Installation

To get started with Orbital Radar, follow these steps to set up the environment and install the package:

  1. Create a New Conda Environment:

    First, create a new Conda environment with Python 3.11 and activate it:

    conda create -n orbital-radar-env python=3.11
    conda activate orbital-radar-env
    
  2. Install the Package:

    Navigate to the orbital-radar source directory and install the package using pip:

    cd orbital_radar-0.0.2
    python3 -m pip install .
    

    For development purposes, you can install the package in editable mode with all the development dependencies:

    python3 -m pip install -e .[dev]
    

    For Mac users use the following line:

    python3 -m pip install -e ."[dev]"
    
  3. Test the Installation:

    To verify that Orbital Radar has been successfully installed, you can run a few tests.

    • Test the package from a Python terminal:

      import orbital_radar
      print(f"Orbital Radar version: {orbital_radar.__version__}")
      
    • Test the command line interface:

      orbital-radar --help
      

Once you’ve completed the installation and verified its success, you can proceed to the “Getting Started” section to begin using Orbital Radar for your specific needs.

Note

To make the orbital-radar-env environment available in Jupyter Lab, please install the ipykernel package with:

conda activate orbital-radar-env
conda install -c conda-forge ipykernel

Then, register the environment as a kernel with:

python -m ipykernel install --user --name=orbital-radar-env