Skip to content

Commit

Permalink
Merge pull request #42 from aerospaceresearch/Vladyslav_dev
Browse files Browse the repository at this point in the history
Major update.
  • Loading branch information
7andahalf committed May 31, 2019
2 parents 6740719 + 080e701 commit 804be78
Show file tree
Hide file tree
Showing 59 changed files with 1,491 additions and 837 deletions.
68 changes: 64 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Direct Demodulation of Radio-signals
To run: run 'python main.py IQ.wav'

(using Docker)

```
sudo docker build --tag direct_demod .
sudo docker run --rm -it \
Expand All @@ -18,13 +19,72 @@ sudo docker run --rm -it \

## Install

### Linux
**Note.** If you install with pip, then to use georeferencer you will have
to install `gdal` manually, therefore for using georeferencer, installation
with conda is recommended.

### Install with `conda`

To install package with conda you should install anaconda or miniconda first.
See installation: https://docs.conda.io/en/latest/miniconda.html.

You can install DirectDemod on linux, using the `install.sh` script. Steps are given below.
When conda is installed, clone the repository and create conda environment from `environment.yml` file.

1. Change the mode of file, to make it executable. `sudo chmod +x ./install`.
```
git clone https://github.com/aerospaceresearch/DirectDemod
cd DirectDemod/
conda env create -f environment.yml -n env_name
conda activate env_name
```

Add `directdemod` package to your `PYTHONPATH` in `.bashrc`.

```
export PYTHONPATH=$PYTHONPATH:/path/to/DirectDemod
```

2. Execute the file using sudo only. `sudo ./install`.
Update `.bashrc`.

```
source ~/.bashrc
```

### Install with pip

To install with pip, fist clone repository, then install requirements with `pip`

```
git clone https://github.com/aerospaceresearch/DirectDemod
cd DirectDemod/
pip install -r requirements.txt
```

Add `directdemod` package to your `PYTHONPATH` in `.bashrc`.

```
export PYTHONPATH=$PYTHONPATH:/path/to/DirectDemod
```

Update `.bashrc`.

```
source ~/.bashrc
```

For installation of `gdal` please refer to

- https://mothergeo-py.readthedocs.io/en/latest/development/how-to/gdal-ubuntu-pkg.html.

### Test installation

To test installation, run the following command. You should see message, that
tests were passed successfully.

**Note:** in case you haven't installed `gdal` part of the tests will result in errors.

```
pytest
```

## Documentation
Please find the docs at: [directdemod.readthedocs.io](https://directdemod.readthedocs.io)
Expand Down
7 changes: 6 additions & 1 deletion directdemod/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,14 @@
## Merger settings
RESOLUTION = 500
COLOR = "black"
TEMP_TIFF_FILE = "_temp.tiff"

## Georeferencer settings
TEMP_TIFF_FILE = "_temp.tif"
DEFAULT_RS = "EPSG:4326"

TLE_NOAA = "../tle/noaa18_June_14_2018.txt"
BORDERS = "../samples/shapes/borders.shp" # should be used in directdemod directory

###### Do not change these

## Source types
Expand Down

0 comments on commit 804be78

Please sign in to comment.