README.rst

Flik

An experimental local optimization package.

Installation

Flik can be installed with pip (system wide or in a virtual environment):

pip install flik

Alternatively, you can install Flik in your home directory:

pip install flik --user

Lastly, you can also install Flik with conda. (See https://www.continuum.io/downloads)

conda install -c QuantumElephant flik

Testing

The tests can be executed as follows:

nosetests flik

Background and usage

Put some more details here

Release history

• 2018-15-02 0.0.0

  Initial Release

How to make a release (Github, PyPI and anaconda.org)

Before you do this, make sure everything is OK. The PyPI releases cannot be undone. If you delete a file from PyPI (because of a mistake), you cannot upload the fixed file with the same filename! See pypa/packaging-problems#74

1. Update the release history.
2. Commit the final changes to master and push to github.
3. Wait for the CI tests to pass. Check if the README looks ok, etc. If needed, fix things and repeat step 2.
4. Make a git version tag: git tag <some_new_version> Follow the semantic versioning guidelines: http://semver.org
5. Push the tag to github: git push origin master --tags