From c3ba3ba4c9a1a8b9e5131475d6e23700f6d261b4 Mon Sep 17 00:00:00 2001 From: Marco Tezzele Date: Mon, 11 Apr 2016 14:51:54 +0200 Subject: [PATCH 1/3] how to install --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 53ed10ff..3cb9326a 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ If you find this collection useful, feel free to download, use it and suggest pu **PyGeM** requires: - **numpy**; - **numpy-stl**; +- **scipy**; - **matplotlib**; -- **vtk**; The official distribution is on GitHub, and you can clone the repository using @@ -44,6 +44,20 @@ The official distribution is on GitHub, and you can clone the repository using git clone https://github.com/mathLab/PyGeM +To install the package just type: + +```bash +> python setup.py install +``` + +To uninstall the package you have to rerun the installation and record the installed files in order to remove them: + +```bash +> python setup.py install --record installed_files.txt +> cat installed_files.txt | xargs rm -rf +``` + + ## Documentation **PyGeM** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation. To build the html versions of the docs simply: From 6d52171dc6795dba31977f3559cb70ecd4d4f03c Mon Sep 17 00:00:00 2001 From: Marco Tezzele Date: Mon, 11 Apr 2016 14:54:02 +0200 Subject: [PATCH 2/3] how to install --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3cb9326a..a266eef9 100644 --- a/README.md +++ b/README.md @@ -46,25 +46,22 @@ The official distribution is on GitHub, and you can clone the repository using To install the package just type: -```bash -> python setup.py install -``` + python setup.py install + To uninstall the package you have to rerun the installation and record the installed files in order to remove them: -```bash -> python setup.py install --record installed_files.txt -> cat installed_files.txt | xargs rm -rf -``` + python setup.py install --record installed_files.txt + cat installed_files.txt | xargs rm -rf + ## Documentation **PyGeM** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation. To build the html versions of the docs simply: -```bash -> cd docs -> make html -``` + cd docs + make html + The generated html can be found in `docs/build/html`. Open up the `index.html` you find there to browse. @@ -74,9 +71,8 @@ We are using Travis CI for continuous intergration testing. You can check out th To run tests locally: -```bash -> python test.py -``` + python test.py + ## Authors and contributors From 44d46c0af7107342279c5740895d534d2baa03de Mon Sep 17 00:00:00 2001 From: Marco Tezzele Date: Mon, 11 Apr 2016 15:12:28 +0200 Subject: [PATCH 3/3] how to install --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a266eef9..78b358d2 100644 --- a/README.md +++ b/README.md @@ -41,27 +41,31 @@ If you find this collection useful, feel free to download, use it and suggest pu The official distribution is on GitHub, and you can clone the repository using - git clone https://github.com/mathLab/PyGeM - +```bash +> git clone https://github.com/mathLab/PyGeM +``` To install the package just type: - python setup.py install - +```bash +> python setup.py install +``` To uninstall the package you have to rerun the installation and record the installed files in order to remove them: - python setup.py install --record installed_files.txt - cat installed_files.txt | xargs rm -rf - +```bash +> python setup.py install --record installed_files.txt +> cat installed_files.txt | xargs rm -rf +``` ## Documentation **PyGeM** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation. To build the html versions of the docs simply: - cd docs - make html - +```bash +> cd docs +> make html +``` The generated html can be found in `docs/build/html`. Open up the `index.html` you find there to browse. @@ -71,8 +75,9 @@ We are using Travis CI for continuous intergration testing. You can check out th To run tests locally: - python test.py - +```bash +> python test.py +``` ## Authors and contributors