Initial commit

.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+* Krotov version:
+* Python version:
+* Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

.gitignore

@@ -0,0 +1,105 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# ctags
+tags

.travis.yml

@@ -0,0 +1,25 @@
+# Config file for automatic testing at travis-ci.org
+
+language: python
+python:
+  # We don't actually use the Travis Python, but this keeps it organized.
+  - 3.6
+  - 3.5
+install:
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda3.sh;
+  - bash miniconda3.sh -b -p $HOME/miniconda
+  - source $HOME/miniconda3/etc/profile.d/conda.sh
+  - conda activate
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda create -q -n test_env python=$TRAVIS_PYTHON_VERSION
+  - conda activate test_env
+  - conda config --append channels conda-forge
+  - conda install qutip
+  - pip install -e .[dev]
+  - pip install coveralls
+
+script:
+  - py.test --doctest-modules --cov=krotov src tests docs/*.rst
+after_success:
+  - coveralls

AUTHORS.rst

@@ -0,0 +1,17 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Michael Goerz <[email protected]>
+
+Development Team
+----------------
+
+* Daniel Reich <[email protected]>
+* Daniel Basilewitsch <[email protected]>
+* Fernando Gago Encinas
+* Matthias Krauss
+* Christane Koch <[email protected]>

CONTRIBUTING.rst

@@ -0,0 +1,105 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/qucontrol/krotov/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 / Implement Features
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for bugs or feature requests. Anybody is welcome to submit a pull request for open issues.
+
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Krotov could always use more documentation, whether as part of the
+official Krotov 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/qucontrol/krotov/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? Follow `Aaron Meurer's Git Workflow Notes`_ (with ``qucontrol/krotov`` instead of ``sympy/sympy``)
+
+In short, *if you are not a member of the `qucontrol organization`_*,
+
+1. Clone the repository from ``[email protected]:qucontrol/krotov.git``
+2. Fork the repo on GitHub to your personal account.
+3. Add your fork as a remote.
+4. Pull in the latest changes from the master branch.
+5. Create a topic branch
+6. Make your changes and commit them (testing locally)
+7. Push changes to the topic branch on *your* remote
+8. Make a pull request against the base master branch through the Github website of your fork.
+
+The project contains a ``Makefile`` to help with development tasts. In your checked-out clone, do
+
+.. code-block:: console
+
+    $ make help
+
+to see the available make targets.
+
+If you are a member of the `qucontrol organization`_, there is no need to fork
+``krotov``: you can directly pull and push to ``[email protected]:qucontrol/krotov.git``.
+
+It is strongly recommended that you use the conda_ package manager. The
+``Makefile`` relies on conda to create local testing and documentation building
+environements (``make test`` and ``make docs``).
+
+Alternatively, you may  use ``make develop-test`` and ``make develop-docs`` to
+run the tests or generate the documentation within your active Python
+environment. You will have to ensure that all the necessary dependencies are
+installed. Also, you will not be able to test the package against all supported
+Python versions.
+You still can (and should) look at https://travis-ci.org/qucontrol/krotov/ to check that your commits pass all tests.
+
+
+.. _conda: https://conda.io/docs/
+
+.. _Aaron Meurer's Git Workflow Notes:  https://www.asmeurer.com/git-workflow/
+
+.. _qucontrol organization: https://github.com/qucontrol
+
+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. Check https://travis-ci.org/qucontrol/krotov/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+

HISTORY.rst

@@ -0,0 +1,8 @@
+=======
+History
+=======
+
+0.0.1 (2018-11-06)
+------------------
+
+* Initial release: this is non-functional placeholder release

LICENSE

@@ -0,0 +1,29 @@
+BSD License
+
+Copyright (c) 2018, Christiane Koch
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,12 @@
+graft src
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif