Add draft doc
This commit is contained in:
37
docs/source/_rst/contributing.rst
Normal file
37
docs/source/_rst/contributing.rst
Normal file
@@ -0,0 +1,37 @@
|
||||
How to contribute
|
||||
=================
|
||||
|
||||
We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
|
||||
|
||||
Submitting a patch
|
||||
------------------
|
||||
|
||||
1. It's generally best to start by opening a new issue describing the bug or
|
||||
feature you're intending to fix. Even if you think it's relatively minor,
|
||||
it's helpful to know what people are working on. Mention in the initial
|
||||
issue that you are planning to work on that bug or feature so that it can
|
||||
be assigned to you.
|
||||
|
||||
2. Follow the normal process of forking the project, and setup a new
|
||||
branch to work in. It's important that each group of changes be done in
|
||||
separate branches in order to ensure that a pull request only includes the
|
||||
commits related to that bug or feature.
|
||||
|
||||
3. To ensure properly formatted code, please make sure to use 4
|
||||
spaces to indent the code. The easy way is to run on your bash the provided
|
||||
script: ./code_formatter.sh. You should also run pylint over your code.
|
||||
It's not strictly necessary that your code be completely "lint-free",
|
||||
but this will help you find common style issues.
|
||||
|
||||
4. Any significant changes should almost always be accompanied by tests. The
|
||||
project already has good test coverage, so look at some of the existing
|
||||
tests if you're unsure how to go about it. We're using coveralls that
|
||||
is an invaluable tools for seeing which parts of your code aren't being
|
||||
exercised by your tests.
|
||||
|
||||
5. Do your best to have well-formed commit messages for each change.
|
||||
This provides consistency throughout the project, and ensures that commit
|
||||
messages are able to be formatted properly by various git tools.
|
||||
|
||||
6. Finally, push the commits to your fork and submit a pull request. Please,
|
||||
remember to rebase properly in order to maintain a clean, linear git history.
|
||||
34
docs/source/_rst/installation.rst
Normal file
34
docs/source/_rst/installation.rst
Normal file
@@ -0,0 +1,34 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
**PINA** requires requires `numpy`, `scipy`, `matplotlib`, `future`, `torch`, `sphinx` (for the documentation) and `pytest` (for local test). The code is tested for Python 3, while compatibility of Python 2 is not guaranteed anymore. It can be installed using `pip` or directly from the source code.
|
||||
|
||||
Installing via PIP
|
||||
__________________
|
||||
|
||||
Mac and Linux users can install pre-built binary packages using pip.
|
||||
To install the package just type:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install git+https://github.com/mathLab/PINA.git
|
||||
|
||||
To uninstall the package:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip uninstall pina
|
||||
|
||||
Installing from source
|
||||
______________________
|
||||
The official distribution is on GitHub, and you can clone the repository using
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ git clone https://github.com/mathLab/PINA
|
||||
|
||||
To install the package just type:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install -e .
|
||||
Reference in New Issue
Block a user