Getting Started
Table of Contents
Installing with pip
With conda environments
To get started with the OSCFAR implementation, you’ll need to set up your environment. We recommend using Conda for managing dependencies.
1. Create a Conda Environment:
conda create -n myenv python=3.8 # Or your preferred Python version above 3.8
conda activate myenv
2. Install OSCFAR Package:
pip install oscfar
With a local python distribution
If you are using your default python installation to install this package, you first need to verify the Python version installed:
python --version #or python3
If the version printed out is greater or equal to Python 3.8, you can do the next step to pip install the package.
pip install oscfar
Testing the installation
This is valid for either a conda or a local Python installation.
python #or python3
>>> import oscfar
If you get an error mentioning the DataReader object from fitburst, you are missing one last dependency that needs to be installed by hand.
Installing fitburst
To install fitburst, follow installation instructions on GitHub.
Upgrading the package
Since this package isn’t final, you may run into issues (which can be reported on GitHub). We will try to fix them as soon as possible. If you notice a version change between your installation and the PyPI distribution, you can upgrade the package with:
pip install oscfar --upgrade
To verify your local installation, run:
python
>>> import oscfar
>>> oscfar.__version__