Getting Started

Requirements

Make sure you have Python 3.10 or higher installed.

python --version

[Optional] setup and activate a new virtualenv:

Mac / Linux:

python -m venv .venv
source .venv/bin/activate

Windows:

python -m venv .venv
.venv\Scripts\activate

Installation

Option 1: Install the package from Github (recommended)

pip install git+https://github.com/JonathanSomer/osdr.git

Option 2: Install the package locally for development

The following commands will clone the repo and install the tdm package locally:

git clone git@github.com:JonathanSomer/osdr.git
pip install -e ./osdr

Note

The -e flag is used to install the package in editable mode, which allows you to make changes to the code and have them reflected in the installed package without needing to reinstall.

Tip

You can clone the repo into any directory, just make sure to modify the path ./osdr provided to the pip install command.

Testing the installation

After installation the following command should display the value 1e-06:

python -c "from tdm.utils import microns; print(microns(1))"

Next steps

Proceed to the Examples section to run some examples.