Installation

We recommend installing the package within a virtual environment. At present, the package is compatible exclusively with Python version 3.12. You can create a Python environment using tools like venv or conda. Below are instructions for both methods.

1. Using venv (Built-in Python Tool)

Step 1: Install Python version 3.12 (if not already installed) Ensure you have Python installed. You can download the latest version from python.org.

Step 2: Create a Virtual Environment

  • Open your terminal or command prompt.

  • Navigate to your project folder:

cd /path/to/your/project

  • Run the following command to create a virtual environment (replace adpsenv with your preferred environment name):

python -m venv adpsenv

Step 3: Activate the Environment

  • On Windows:

adpsenv\Scripts\activate

  • On macOS/Linux:

source adpsenv/bin/activate

You’ll see the environment name in your terminal prompt indicating the environment is active.

Step 4: Install Dependencies

Now you can install packages like this:

pip install pyadps

Step 5: Deactivate the Environment

When you’re done working in the environment, deactivate it by running:

deactivate

2. Using conda (Anaconda/Miniconda):

Step 1: Install Conda

First, you need to have Conda installed on your system. You can either install:

Step 2: Create a Conda Environment with Python 3.12

Once Conda is installed, open a terminal or command prompt and run the following to create a new environment (replace adpsenv with your preferred environment name):

conda create --name adpsenv python=3.12

Step 3: Activate the Environment

conda activate adpsenv

Step 4: Install Dependencies

You can install packages with pip inside Conda environments.

pip install pyadps

Step 5: Deactivate the Environment

When done, deactivate the environment by running:

conda deactivate