Skip to content

Commit

Permalink
update clone urls etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaume committed Jan 13, 2014
1 parent 9990099 commit 49d7642
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
31 changes: 16 additions & 15 deletions pyana/__init__.py
@@ -1,6 +1,6 @@
"""
This package provides a sample setup to get started with ccsgp_. `ccsgp` is
This package_ provides a sample setup to get started with ccsgp_. `ccsgp` is
initialized as a module and its usage demonstrated with dedicated functions in
the examples module. Helpful utility functions are also included to complement
the features of `ccsgp`. The following use cases are currently implemented or
Expand All @@ -24,19 +24,19 @@
2. clone the `ccsgp_get_started` git repository.
* Include the submodule with the test data by cloning the git repository
recursively::
Include the submodule with the test data by cloning the git repository
recursively::
$ git clone https://github.com/tschaume/ccsgp_get_started.git --recursive
$ cd ccsgp_get_started/
$ git clone https://github.com/tschaume/ccsgp_get_started.git --recursive
$ cd ccsgp_get_started/
* or alternatively, for source code only, clone and init the `ccsgp`
submodule separately::
or alternatively, for source code only, clone and init the `ccsgp`
submodule separately::
$ git clone https://github.com/tschaume/ccsgp_get_started.git
$ cd ccsgp_get_started/
$ git submodule init pyana/ccsgp
$ git submodule update
$ git clone https://github.com/tschaume/ccsgp_get_started.git
$ cd ccsgp_get_started/
$ git submodule init pyana/ccsgp
$ git submodule update
3. init the virtualenv_, activate it and install all requirements::
Expand All @@ -45,13 +45,13 @@
$ pip install -U numpy
$ pip install -U -r requirements.txt
* Every time you start in a new terminal you have to activate the correct
- Every time you start in a new terminal you have to activate the correct
python environment by sourcing `env/bin/activate` again or instead use
`env/bin/python` directly!
* The h5py package requirement is currently omitted from the requirements. If
you want to use it, uncomment the h5py requirement in ``requirements.txt``
and rerun ``$ pip install -r requirements.txt``.
- The h5py package is currently omitted from the requirements. If you want to
use it, uncomment the h5py requirement in ``requirements.txt`` and rerun ``$
pip install -r requirements.txt``.
4. If you intend to run the examples (and you cloned recursively above), symlink
*pyanaDir* to *ccsgp_get_started_data*::
Expand All @@ -63,6 +63,7 @@
*pyanaDir* either to *ccsgp_get_started_data* or your own input/output
directory (preferably separated from the code repository).
.. _package: https://github.com/tschaume/ccsgp_get_started
.. _ccsgp: https://github.com/tschaume/ccsgp
.. _ccsgp_get_started: https://github.com/tschaume/ccsgp_get_started
.. _virtualenv: http://www.virtualenv.org/en/latest/virtualenv.html#usage
Expand Down
8 changes: 4 additions & 4 deletions pyana/examples/__init__.py
Expand Up @@ -7,8 +7,10 @@
$ python -m pyana
(this runs `pyana/__main__.py`). Alternatively, you can run a
specific module, for instance::
.. [#] ccsgp_get_started_data/input/examples/gp_datdir/WorldBankIndicators.csv
.. [#] ccsgp_get_started_data/input/examples/gp_datdir/genExDat.sh
Alternatively, you can run a specific module, for instance::
$ python -m pyana.examples.gp_datdir [--log] <country-initial> <#-most-populated>
Expand All @@ -18,6 +20,4 @@
the source code and use one of the examples as a template.
.. _Indicators: http://www.tableausoftware.com/public/community/sample-data-sets#worldbank
.. [#] ccsgp_get_started_data/input/examples/gp_datdir/WorldBankIndicators.csv
.. [#] ccsgp_get_started_data/input/examples/gp_datdir/genExDat.sh
"""

0 comments on commit 49d7642

Please sign in to comment.