diff --git a/README.md b/README.md index febbc8d4d5416d6eaae11057e2e24438ae95c85f..10e5de6c98f070fe9f7adefe146b5b4bd0835889 100755 --- a/README.md +++ b/README.md @@ -18,5 +18,33 @@ https://doi.org/10.5281/zenodo.2594690 Cite using : DOI: 10.5281/zenodo.2594690 -Install with : +# Pip installation with : pip install impetuous-gfa + +# Version controlled installation of the Impetuous library + +The Impetuous library + +In order to run these code snippets we recommend that you download the nix package manager. Nix package manager links from Oktober 2020: + +https://nixos.org/download.html + +$ curl -L https://nixos.org/nix/install | sh + +If you cannot install it using your Wintendo then please consider installing Windows Subsystem for Linux first: + +https://docs.microsoft.com/en-us/windows/wsl/install-win10 + +In order to run the code in this notebook you must enter a sensible working environment. Don't worry! We have created one for you. It's version controlled against python3.7 and you can get the file here: + +https://github.com/richardtjornhammar/rixcfgs/blob/master/code/environments/impetuous-shell.nix + +Since you have installed Nix as well as WSL, or use a Linux (NixOS) or bsd like system, you should be able to execute the following command in a termnial: + +$ nix-shell impetuous-shell.nix + +Now you should be able to start your jupyter notebook locally: + +$ jupyter-notebook impetuous_finance.ipynb + +and that's it. diff --git a/setup.py b/setup.py index 6beb1ecef15ecf22e517954958dfb6428e2e702f..a39a6c531c0081571aba7887f543215dac2d0862 100755 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open("README.md", "r") as fh: setuptools.setup( name = "impetuous-gfa", - version = "0.21.4", + version = "0.22.0", author = "Richard Tjörnhammar", author_email = "richard.tjornhammar@gmail.com", description = "Impetuous Quantification, Alignments, Enrichments and Group Analysis",