Built from makenew/python-package.
Python analysis code for dichalcogenide systems.
Considered unstable and in development until version 1.0.0 is released.
Add this line to your application's requirements.txt
and install it with
$ pip install -r requirements.txt
If you are writing a Python package which will depend on this,
add this to your requirements in
Alternatively, install it directly using pip with
$ pip install dichalcogenides
Development and Testing
The dichalcogenides source is hosted on GitHub. Clone the project with
$ git clone https://github.com/razor-x/dichalcogenides.git
Install the development dependencies with
$ pip install -r requirements.devel.txt
Lint code with
$ python setup.py lint
Run tests with
$ python setup.py test
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/razor-x/dichalcogenides/fork).
- Create your feature branch (
git checkout -b my-new-feature).
- Make changes. Write and run tests.
- Commit your changes (
git commit -am 'Add some feature').
- Push to the branch (
git push origin my-new-feature).
- Create a new Pull Request.
This Python package is licensed under the MIT license.
This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.