diff --git a/README.md b/README.md index 8790202..110c6cc 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,47 @@ sudo docker run --rm -it \ direct_demod python main.py samples/SDRSharp_20170830_073907Z_145825000Hz_IQ_autogain.wav ``` +## Install with `conda` + + +To install package with conda you should install anaconda or miniconda distribution first. +See installation: https://docs.conda.io/en/latest/miniconda.html. + +When conda is installed, clone the repository and create conda a new conda environment. (To keep different versions of your packages of different project from interfering with each other) + +``` +git clone https://github.com/aerospaceresearch/DirectDemod +cd DirectDemod/ +conda create -n env_name +conda activate env_name (or source activate env_name, if the previous doesn't work, In some environments, it might be deprecated) +conda config --add channels conda-forge +conda install --file requirements.txt + +``` + +You should add `directdemod` package to your `PYTHONPATH`. +
+On Windows edit environment variable `PYTHONPATH` and append path to DirectDemod directory to it. +On Linux edit `.bashrc`: + +``` +export PYTHONPATH=$PYTHONPATH:/path/to/DirectDemod +``` + +Update `.bashrc`. + +``` +source ~/.bashrc +``` + +### Test installation + +To test installation, run the following command (from `DirectDemod` directory). You should see, that all +tests were passed successfully. Occasional warnings are ok. + +``` +pytest +``` ## Documentation Please find the docs at: [directdemod.readthedocs.io](https://directdemod.readthedocs.io) diff --git a/main.py b/main.py index 5cc842b..e2e0d34 100644 --- a/main.py +++ b/main.py @@ -351,4 +351,4 @@ def usage(err = ""): # write report if not reportFile is None: with open(reportFile, 'w') as outfile: - json.dump(reportDict, outfile) \ No newline at end of file + json.dump(reportDict, outfile) diff --git a/requirements.txt b/requirements.txt index 2976f5d..52640a3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,4 +9,4 @@ pytest==3.4.0 python-dateutil==2.6.1 pytz==2018.3 scipy==1.0.0 -six==1.11.0 \ No newline at end of file +six==1.11.0