diff --git a/README.md b/README.md index 2dcc1fac3faf645ce767fab6e9ecb0099a00c646..88e2f7d987f31c417dc9691d7d547b24c4def939 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,34 @@ -# Tacos +# TACOS -Tacos is a diverse Set Of Commands And Tools (SOCAT, but TACOS sounds much better!). +TACOS is a diverse Set Of Commands And Tools (SOCAT, but TACOS sounds much better!). ## Basic setup Create virtual environment ``` $ conda update conda -$ conda create --prefix=tacos_env -c intel intelpython3_core python=3.5 icu=58 pandas -$ conda activate ./tacos_env +$ conda create --prefix=<path/tacos_env> -c intel intelpython3_core python=3.5 icu=58 pandas +$ conda activate <path/tacos_env> $ conda install -c conda-forge python-igraph ``` Install Tacos: ``` -$ git clone $ -$ pip install --editable . +$ git clone https://git.scicore.unibas.ch/TBRU/tacos.git +$ cd tacos +$ pip install . ``` Run the application: ``` +$ conda activate <path/tacos_env> $ tacos --help ``` +or +``` +$ <path/tacos_env>/bin/python -m tacos --help +``` To run the tests: ``` - $ pytest tests +$ pytest tests ``` diff --git a/setup.py b/setup.py index 827111011e5cc66e8be6eca38743d72d61e2c80b..5446bf48a29be4d244edc6bee1df6477b6a08ea1 100644 --- a/setup.py +++ b/setup.py @@ -2,8 +2,9 @@ from setuptools import setup setup( name='tacos', + author='Monica R. Ticlla', version='0.1', - py_modules=['Tacos'], + py_modules=['tacos'], install_requires=[ 'Click', 'numpy', @@ -12,6 +13,6 @@ setup( ], entry_points=''' [console_scripts] - tacos=Tacos:tacos + tacos=tacos:tacos ''', ) \ No newline at end of file diff --git a/Tacos.py b/tacos.py similarity index 100% rename from Tacos.py rename to tacos.py