Verified Commit ef7aa2d2 authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Update documentation

parent 387f3d71
Authors
=======
The main developers of the energy related operators are
* Adel Kara Slimane (CEA Saclay)
......
......@@ -112,7 +112,7 @@ with the following command:
.. code:: shell
mpirun -n 4 -bind-to none python3 doc/examples/quantum_dot.py
$ mpirun -n 4 -bind-to none python3 doc/examples/quantum_dot.py
The ``-bind-to none`` option is there to not force the OS to use specific
threads to run the 4 copies. If the option is not used, the code will run
......@@ -125,11 +125,55 @@ choosing the threads on which to run the script
.. code:: shell
mpirun -n 5 --cpu-set 0-4 --bind-to core python3 doc/examples/quantum_dot.py
$ mpirun -n 5 --cpu-set 0-4 --bind-to core python3 doc/examples/quantum_dot.py
Where threads 0,1,2,3,4 will be used for the calculations, the same
command can be written:
.. code:: shell
mpirun -n 5 --cpu-set 0,1,2,3,4 --bind-to core python3 doc/examples/quantum_dot.py
$ mpirun -n 5 --cpu-set 0,1,2,3,4 --bind-to core python3 doc/examples/quantum_dot.py
Development
===========
Source code
~~~~~~~~~~~
tkwantoperator source code is available at https://gitlab.kwant-project.org/kwant/tkwantoperator. It can be cloned locally with git:
.. code:: shell
$ git clone https://gitlab.kwant-project.org/kwant/tkwantoperator.git
The older commit history of the energy operators code can be found here: https://gitlab.kwant-project.org/spec-gmt/tkwant-energy-transport
Documentation
~~~~~~~~~~~~~
To build locally the documentation of `tkwantoperator`, few additional (on top of the ones needed in :ref:`install`) python packages are required:
.. code:: shell
$ pip3 install sphinx, jupyter-sphinx
The documentation can then be build directly in the ``doc`` folder of the
local tkwantoperator source code repository from the command line:
.. code:: shell
$ cd path/to/tkwantoperaotor/tkwantoperator/doc
$ make html
The generated HTML documentation will then be found in the ``doc/build/html`` folder. The root webpage is ``doc/build/html/index.html``, it can be opened with a web browser to browse the generated documentation.
Testing
~~~~~~~
Tests can be run directly in the local tkwantoperator source repository from the command line:
.. code:: shell
$ cd path/to/tkwantoperaotor
$ pytest tkwantoperator
\ No newline at end of file
This module is an extension to tkwant that implements additional operators. Currently, the extension includes energy related operators: current, density, source and heat current.
About tkwantoperator
====================
``tkwantoperator`` is an opensource python package that extends the `tkwant <https://kwant-project.org/extensions/tkwant/>`_ library with additional operators. Currently, the extension includes energy related operators: current, density, source and heat current. ``tkwantoperator`` is distributed under the `2-clause BSD license <https://gitlab.kwant-project.org/kwant/tkwantoperator/-/blob/master/LICENSE.rst>`_
Install instructions
~~~~~~~~~~~~~~~~~~~~
Complete install instructions can be found in :ref:`install` (or the file `INSTALL.rst <https://gitlab.kwant-project.org/kwant/tkwantoperator/-/blob/master/INSTALL.rst>`_ in the git repository).
Commit history
~~~~~~~~~~~~~~
The commit history of the energy operators code can be found in the following git repository: https://gitlab.kwant-project.org/spec-gmt/tkwant-energy-transport
\ No newline at end of file
Complete install instructions can be found in :ref:`install` (or the file `INSTALL.rst <https://gitlab.kwant-project.org/kwant/tkwantoperator/-/blob/master/INSTALL.rst>`_ in the git repository).
\ No newline at end of file
About tkwantoperator
====================
.. include:: ../../../README.rst
=======
Authors
=======
.. include:: ../../../AUTHORS.rst
......@@ -13,8 +13,8 @@ Helper Classes
EnergySiteValidator
Observables
-----------
Energy observables
------------------
.. autosummary::
:toctree: generated/
:template: autosummary/class.rst
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment