Skip to content
Permalink
Browse files

adds sphinx documentation

  • Loading branch information...
verginer committed Feb 27, 2018
1 parent 084865a commit 19ebe3f69d5763acbce15f4dda935885c258757a
Showing with 140 additions and 3 deletions.
  1. +128 −0 CONTRIBUTING.rst
  2. +8 −0 HISTORY.rst
  3. +4 −3 pathpy/measures/path_measures.py
@@ -0,0 +1,128 @@
.. highlight:: shell

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/IngoScholtes/pathpy/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

pathpy could always use more documentation, whether as part of the
official pathpy docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/IngoScholtes/pathpy/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `pathpy` for local development.

1. Fork the `pathpy` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/pathpy.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv pathpy
$ cd pathpy/
$ python setup.py develop

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 pathpy tests
$ python setup.py test or py.test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
https://travis-ci.org/IngoScholtes/pathpy/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ py.test tests.test_pathpy


Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
@@ -0,0 +1,8 @@
=======
History
=======

1.2.1 (2018-02-23)
------------------

* First release on PyPI.
@@ -181,7 +181,8 @@ def slow_down_factor(paths, k=2, lanczos_vectors=15, maxiter=1000):
Parameters
----------
paths
paths: Paths
the Paths object to compute the slow down factor for
k: int
order of the model to consider
lanczos_vectors: int
@@ -191,8 +192,8 @@ def slow_down_factor(paths, k=2, lanczos_vectors=15, maxiter=1000):
maxiter: int
scaling factor for the number of iterations to be used in the approximate
calculation of eigenvectors and eigenvalues. The number of iterations passed to
scipy's underlying eigs function will be n*maxiter where n is the number of
rows/columns of the Laplacian matrix.
scipy's underlying eigs function will be n*maxiter where n is the number of
rows/columns of the Laplacian matrix.
Returns
-------

0 comments on commit 19ebe3f

Please sign in to comment.
You can’t perform that action at this time.