Python analysis code for dichalcogenide systems.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dichalcogenides
docs
.editorconfig
.gitignore
CHANGELOG.md
LICENSE.txt
Makefile
README.rst
circle.yml
pylintrc
requirements.devel.txt
requirements.rtd.txt
requirements.txt
setup.cfg
setup.py

README.rst

Dichalcogenides

PyPI GitHub license Requires.io CircleCI Documentation Status

Built from makenew/python-package.

Description

Python analysis code for dichalcogenide systems.

Considered unstable and in development until version 1.0.0 is released.

Installation

This package is registered on the Python Package Index (PyPI) as dichalcogenides.

Add this line to your application's requirements.txt

dichalcogenides

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 setup.py.

Alternatively, install it directly using pip with

$ pip install dichalcogenides

Development and Testing

Source Code

The dichalcogenides source is hosted on GitHub. Clone the project with

$ git clone https://github.com/razor-x/dichalcogenides.git

Requirements

You will need Python 3 with pip.

Install the development dependencies with

$ pip install -r requirements.devel.txt

Tests

Lint code with

$ python setup.py lint

Run tests with

$ python setup.py test

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

  1. Fork it (https://github.com/razor-x/dichalcogenides/fork).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Make changes. Write and run tests.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin my-new-feature).
  6. Create a new Pull Request.

License

This Python package is licensed under the MIT license.

Warranty

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.