Skip to content
Snippets Groups Projects
README.md 1.18 KiB
Newer Older
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
# af2parser: AF2 plots parser
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed

Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
For handling (minimal) dependencies you can use **conda** or **miniconda** environments. Detailed installation instructions for each of them can be found [here](https://docs.conda.io/en/latest/index.html) and [here](https://docs.conda.io/en/latest/miniconda.html). After installing conda (if needed) create and activate an enironment:
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed

```
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
conda create -n af2plots
conda activate af2plots
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
```

alternatively, you can use miniconda. It doesn't require any changes to you system and it's fully contained in a local directory. To install it download an installer from [here](https://docs.conda.io/en/latest/miniconda.html) and run the following (linux example):

```
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
bash Miniconda3-latest-Linux-x86_64.sh -b -p miniconda_af2plots
. miniconda_af2plots/bin/activate
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
```

Now, you can proceed with the installation instructions below


Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
conda install -c conda-forge matplotlib
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
install

```
git clone -b modules --recursive git@git.embl.de:gchojnowski/af2plots.git
cd af2plots
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
python setup.py install
```

and test

```
af2plots --test
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
```

to use it in your scripts

```
from af2plots.plotter import plotter
Grzegorz Chojnowski's avatar
Grzegorz Chojnowski committed
```

basic af2lib usage examples are in af2plots/__main__py