diff --git a/doc/source/_templates/index.html b/doc/source/_templates/index.html index 20b3fed..b4e9d57 100644 --- a/doc/source/_templates/index.html +++ b/doc/source/_templates/index.html @@ -37,28 +37,29 @@ and next steps, and advance with the coding of the software. {%endtrans%}

{%trans%}Getting started{%endtrans%}

{%trans%}Documentation{%endtrans%}

{%trans%}Links{%endtrans%}

diff --git a/doc/source/_themes/sphinx13/layout.html b/doc/source/_themes/sphinx13/layout.html index 8905780..2031c03 100644 --- a/doc/source/_themes/sphinx13/layout.html +++ b/doc/source/_themes/sphinx13/layout.html @@ -70,9 +70,9 @@
diff --git a/doc/source/contents.rst b/doc/source/contents.rst index a364406..78f46e1 100644 --- a/doc/source/contents.rst +++ b/doc/source/contents.rst @@ -2,14 +2,9 @@ Documentation ============= .. toctree:: - :maxdepth: 2 + :maxdepth: 3 about download - user_manual/index - reference_manual/index - faq - issues - develop - coding/index - help + users/index + develop/index diff --git a/doc/source/develop.rst b/doc/source/develop.rst deleted file mode 100644 index 942d182..0000000 --- a/doc/source/develop.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _develop: - -Develop -======= - -ctools is an open source projet and you are highly welcome to contribute -to the development. -Contributions can come in any areas: writing C++ code, contributing Python -scripts, writing documentation, testing code, etc. - -The ctools software development is managed by a -`Redmine `_ platform. -Please check out the -`Wiki `_ -on that platform to learn how you can contribute to the ctools software -development. - -You may also want to get in the ctools information flow by subscribing to -the ctools@irap.omp.eu mailing list. -To subscribe simply send an e-mail to ctools-subscribe@irap.omp.eu. - -We are organising regular `Coding sprints `_ -to allow newcomers to get familiar with the code base and the coding -practices. -You are highly invited to join one of the next coding sprints. - -You can also follow `@ctools_software `_ on -twitter to get informed about new ctools releases. \ No newline at end of file diff --git a/doc/source/coding/cpp.rst b/doc/source/develop/coding/cpp.rst index 3c1a593..3c1a593 100644 --- a/doc/source/coding/cpp.rst +++ b/doc/source/develop/coding/cpp.rst diff --git a/doc/source/coding/general.rst b/doc/source/develop/coding/general.rst index b52f87e..b52f87e 100644 --- a/doc/source/coding/general.rst +++ b/doc/source/develop/coding/general.rst diff --git a/doc/source/coding/index.rst b/doc/source/develop/coding/index.rst index 0d85f34..0d85f34 100644 --- a/doc/source/coding/index.rst +++ b/doc/source/develop/coding/index.rst diff --git a/doc/source/coding/introduction.rst b/doc/source/develop/coding/introduction.rst index 3ff85b0..3ff85b0 100644 --- a/doc/source/coding/introduction.rst +++ b/doc/source/develop/coding/introduction.rst diff --git a/doc/source/coding/python.rst b/doc/source/develop/coding/python.rst index 417da50..417da50 100644 --- a/doc/source/coding/python.rst +++ b/doc/source/develop/coding/python.rst diff --git a/doc/source/develop/git/git-workflow.png b/doc/source/develop/git/git-workflow.png new file mode 100644 index 0000000..dc4f3fd --- /dev/null +++ b/doc/source/develop/git/git-workflow.png diff --git a/doc/source/develop/git/gitlab-fork-step1.jpg b/doc/source/develop/git/gitlab-fork-step1.jpg new file mode 100644 index 0000000..4f89982 --- /dev/null +++ b/doc/source/develop/git/gitlab-fork-step1.jpg diff --git a/doc/source/develop/git/gitlab-fork-step2.jpg b/doc/source/develop/git/gitlab-fork-step2.jpg new file mode 100644 index 0000000..3c8098d --- /dev/null +++ b/doc/source/develop/git/gitlab-fork-step2.jpg diff --git a/doc/source/develop/git/gitlab-fork-step3.jpg b/doc/source/develop/git/gitlab-fork-step3.jpg new file mode 100644 index 0000000..11857a0 --- /dev/null +++ b/doc/source/develop/git/gitlab-fork-step3.jpg diff --git a/doc/source/develop/git/gitlab-push.jpg b/doc/source/develop/git/gitlab-push.jpg new file mode 100644 index 0000000..3964820 --- /dev/null +++ b/doc/source/develop/git/gitlab-push.jpg diff --git a/doc/source/develop/git/index.rst b/doc/source/develop/git/index.rst new file mode 100644 index 0000000..8eee7b9 --- /dev/null +++ b/doc/source/develop/git/index.rst @@ -0,0 +1,241 @@ +.. _git: + +Using Git and GitLab +==================== + +The ctools source code is version controlled using +`Git `_ that is managed through a +`GitLab `_ web interface. + +Every developer will create a user in +`GitLab `_ +and have an own copy (a so called fork) of the ctools code in his/her +user space. +There is hence no need or possibility to push to the main ctools repository. +Once you forked from the ctools repository, you can create +feature branches and add some new code (or correct a bug), and issue a pull +request so that your change gets included in the trunk. +Note that we do not use +`GitLab's `_ +pull request feature for the moment, as all issues are tracked on our +`Redmine `_ +system, but this may change in the future. +Our `Git `_ workflow is identical to the one you +typically use on `GitHub `_. +You may in fact also use `GitHub `_ +for your code developments, as the ctools source code is mirrored to +`GitHub `_ in a read only repository. + + +Before you start +---------------- + +Make sure you configured your `Git `_ using your user +name and e-mail address (you only need to do this once on your machine): + +.. code-block:: sh + + $ git config --global user.name "John Doe" + $ git config --global user.email johndoe@example.com + +In addition, you may need to add + +.. code-block:: sh + + $ git config --global http.sslverify "false" + +so that you have no SSL certificate error when you access the +repository. + + +Overview +-------- + +The figure below illustrates the `Git `_ workflow +that we use for the ctools development. +Permanent branches are shown as black lines, temporary branches as grey lines. +The yellow area is the ctools repository, the light blue area is your +forked user space. +There are three permanent branches in the ctools repository: + +* the ``master`` branch that holds the latest release +* the ``devel`` branch that is the trunk on which development progresses +* the ``integration`` branch that is used for code integration + +A temporary ``release`` branch is used for hotfixes and generally for code +testing prior to any release. +As developer you will work in your user space and work on temporary +``feature`` branches. + +.. image:: git-workflow.png + :height: 400px + :alt: Git workflow + :align: center + + +Forking the project +------------------- + +As the first step you need to create a fork of the project in your user +space. +Connect to `GitLab `_ +using your Redmine user name and password (if you have not yet an +account on +`Redmine `_ then go +ahead and create one). +Select the `ctools `_ +project and click on ``Fork`` (see below). + +.. image:: gitlab-fork-step1.jpg + :width: 600px + :alt: Forking the ctools repository + :align: center + +This brings you to a screen that invites you to fork the project into +your user space. +Click on your user (see below). + +.. image:: gitlab-fork-step2.jpg + :width: 600px + :alt: Select user + :align: center + +After a short while a fork will be created that now is under your +ownership (see below). + +.. image:: gitlab-fork-step3.jpg + :width: 600px + :alt: Forked created successfully + :align: center + +Now you can clone this fork using + +.. code-block:: sh + + $ git clone https://cta-gitlab.irap.omp.eu/[user]/ctools.git + +where ``[user]`` is your +`GitLab `_ +(or `Redmine `_) +user name. +To keep in sync with the ctools repository you should add it as +a remote repository using + +.. code-block:: sh + + $ git remote add upstream https://cta-gitlab.irap.omp.eu/ctools/ctools.git + +You can then type + +.. code-block:: sh + + $ git pull upstream devel + +to pull in changes from the ``devel`` branch of ctools in your +repository. + + +Modifying or adding code +------------------------ + +To work on a new feature or to correct a bug you should always create a new +branch. +You do this by typing + +.. code-block:: sh + + $ git checkout devel + $ git pull upstream devel + $ git checkout -b 9101-skymap-smooth-method + +which makes sure that you are on your ``devel`` branch, then pulls in changes +from the ctools repository, and finally creates the +``9101-skymap-smooth-method`` branch. +New branches should always start with an issue number, followed by +a meaningful name that indicates what the branch is good for (use hyphens +to separate words). +You can find the relevant issue number using the +`Redmine issue tracker `_. + +Suppose that your goal is to add a ``smooth()`` method to the ``GSkyMap`` +class. +You would then add this method to ``GSkyMap`` by editing the +``GSkyMap.hpp``, ``GSkyMap.cpp`` and ``GSkyMap.i`` files. +You should also add unit tests for the new method, and you would do +this by editing the ``test_GSky.hpp`` and ``test_GSky.cpp`` files. +Once you have verified that the new method works you should commit +your changes. + +First stage all files you want to commit. +To commit for example only the new class method you should type + +.. code-block:: sh + + $ git add src/sky/GSkyMap.hpp + $ git add src/sky/GSkyMap.cpp + $ git add src/sky/GSkyMap.i + +followed by + +.. code-block:: sh + + $ git commit -m "Add GSkyMap::smooth() method (#9101) + > + > The GSkyMap::smooth() allows the smoothing of sky maps using + > various kernels." + +where the message in quotes should be comprised of a single line subject +that describes what was changed, and a message body that describes why +the change was made. Subject line and message body should be separated +by a blank line (see `How to Write a Git Commit Message +`_). + +You should then also stage and commit the remaining files. + +To make the changes available to other users, and specifically to allow +their merging into the ctools repository, you need to push you local +changes into your +`GitLab's `_ +repository. +You do this by typing + +.. code-block:: sh + + $ git push origin 9101-skymap-smooth-method + +Note that the ``origin`` argument specifies that you want to push your +changes into the same repository from which you cloned the code. + +You can now verify on +`GitLab's `_ +that a new branch exists in your project: + +.. image:: gitlab-push.jpg + :width: 600px + :alt: Pushing a new branch + :align: center + + +Creating a pull request +----------------------- + +Once the code is pushed into your repository you can create a request that +your code should be merged into the ctools repository. +For this you have to open the relevant issue in the +`Redmine issue tracker `_ +and put the status of the issue to ``Pull request``: + +.. image:: pull-request.jpg + :width: 600px + :alt: Creating a pull request + :align: center + +You should indiciate in the notes in which repository and on which branch +your change is. +You should also describe the changes or addition you made to the code. +Explain what you have done. Say if there is anything you’d like particular +attention for - like a complicated change or some code you are not happy +with. +If you don’t think your request is ready to be merged, just say so in your +pull request message. +This is still a good way of getting some preliminary code review. diff --git a/doc/source/develop/git/pull-request.jpg b/doc/source/develop/git/pull-request.jpg new file mode 100644 index 0000000..17c7616 --- /dev/null +++ b/doc/source/develop/git/pull-request.jpg diff --git a/doc/source/develop/index.rst b/doc/source/develop/index.rst new file mode 100644 index 0000000..50f68bd --- /dev/null +++ b/doc/source/develop/index.rst @@ -0,0 +1,48 @@ +.. _develop: + +Developer documentation +======================= + +ctools is an open source projet and you are highly welcome to contribute +to the development. +Contributions can come in any areas: writing C++ code, contributing Python +scripts, writing documentation, testing code, etc. + +We manage the ctools source code using `GitLab `_. +We also have a `Redmine `_ +development platform to track issues. +We use a continuous integration system based on +`Jenkins `_ +and we monitor our code quality with +`SonarQube `_. + +You may also want to get in the ctools information flow by subscribing to +the ctools@irap.omp.eu mailing list. +To subscribe simply send an e-mail to ctools-subscribe@irap.omp.eu. + +We are organising regular +`Coding sprints `_ +to allow newcomers to get familiar with the code base and the coding +practices. +You are highly invited to join one of the next coding sprints. + +You can also follow `@ctools_software `_ on +twitter to get informed about new ctools releases. + +Below a few links to learn how to contribute to ctools: + +.. toctree:: + :maxdepth: 1 + + git/index + coding/index + +And here some status shields: + +.. image:: https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=ctools-integrate-os + :target: https://cta-jenkins.irap.omp.eu/job/ctools-integrate-os + :alt: Build Status + +.. image:: https://cta-sonar.irap.omp.eu/api/badges/gate?key=ctools + :target: https://cta-sonar.irap.omp.eu/dashboard/index/ctools + :alt: Quality Gate diff --git a/doc/source/faq.rst b/doc/source/users/faq.rst index 9f9511b..9f9511b 100644 --- a/doc/source/faq.rst +++ b/doc/source/users/faq.rst diff --git a/doc/source/help.rst b/doc/source/users/help.rst index 1571a9d..1571a9d 100644 --- a/doc/source/help.rst +++ b/doc/source/users/help.rst diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst new file mode 100644 index 0000000..d40ae3a --- /dev/null +++ b/doc/source/users/index.rst @@ -0,0 +1,15 @@ +.. _users: + +User Documentation +================== + +.. toctree:: + :maxdepth: 2 + + user_manual/getting + user_manual/getting_started/index + user_manual/index + reference_manual/index + faq + issues + help diff --git a/doc/source/issues.rst b/doc/source/users/issues.rst index ac3f41f..ac3f41f 100644 --- a/doc/source/issues.rst +++ b/doc/source/users/issues.rst diff --git a/doc/source/reference_manual/cscaldb.rst b/doc/source/users/reference_manual/cscaldb.rst index acb70de..acb70de 100644 --- a/doc/source/reference_manual/cscaldb.rst +++ b/doc/source/users/reference_manual/cscaldb.rst diff --git a/doc/source/reference_manual/csfindobs.rst b/doc/source/users/reference_manual/csfindobs.rst index a3ba7a8..a3ba7a8 100644 --- a/doc/source/reference_manual/csfindobs.rst +++ b/doc/source/users/reference_manual/csfindobs.rst diff --git a/doc/source/reference_manual/csiactcopy.rst b/doc/source/users/reference_manual/csiactcopy.rst index 6d0cf23..6d0cf23 100644 --- a/doc/source/reference_manual/csiactcopy.rst +++ b/doc/source/users/reference_manual/csiactcopy.rst diff --git a/doc/source/reference_manual/csiactdata.rst b/doc/source/users/reference_manual/csiactdata.rst index 885281e..885281e 100644 --- a/doc/source/reference_manual/csiactdata.rst +++ b/doc/source/users/reference_manual/csiactdata.rst diff --git a/doc/source/reference_manual/csiactobs.rst b/doc/source/users/reference_manual/csiactobs.rst index 900faf1..900faf1 100644 --- a/doc/source/reference_manual/csiactobs.rst +++ b/doc/source/users/reference_manual/csiactobs.rst diff --git a/doc/source/reference_manual/cslightcrv.rst b/doc/source/users/reference_manual/cslightcrv.rst index cc2196d..cc2196d 100644 --- a/doc/source/reference_manual/cslightcrv.rst +++ b/doc/source/users/reference_manual/cslightcrv.rst diff --git a/doc/source/reference_manual/csmodelinfo.rst b/doc/source/users/reference_manual/csmodelinfo.rst index 2acce45..2acce45 100644 --- a/doc/source/reference_manual/csmodelinfo.rst +++ b/doc/source/users/reference_manual/csmodelinfo.rst diff --git a/doc/source/reference_manual/csmodelmerge.rst b/doc/source/users/reference_manual/csmodelmerge.rst index 6edb2bd..6edb2bd 100644 --- a/doc/source/reference_manual/csmodelmerge.rst +++ b/doc/source/users/reference_manual/csmodelmerge.rst diff --git a/doc/source/reference_manual/csobs2caldb.rst b/doc/source/users/reference_manual/csobs2caldb.rst index e9b475d..e9b475d 100644 --- a/doc/source/reference_manual/csobs2caldb.rst +++ b/doc/source/users/reference_manual/csobs2caldb.rst diff --git a/doc/source/reference_manual/csobsdef.rst b/doc/source/users/reference_manual/csobsdef.rst index 7962157..7962157 100644 --- a/doc/source/reference_manual/csobsdef.rst +++ b/doc/source/users/reference_manual/csobsdef.rst diff --git a/doc/source/reference_manual/csobsinfo.rst b/doc/source/users/reference_manual/csobsinfo.rst index 6d1ef78..6d1ef78 100644 --- a/doc/source/reference_manual/csobsinfo.rst +++ b/doc/source/users/reference_manual/csobsinfo.rst diff --git a/doc/source/reference_manual/cspull.rst b/doc/source/users/reference_manual/cspull.rst index 8c45426..8c45426 100644 --- a/doc/source/reference_manual/cspull.rst +++ b/doc/source/users/reference_manual/cspull.rst diff --git a/doc/source/reference_manual/csresmap.rst b/doc/source/users/reference_manual/csresmap.rst index 8df6dc1..8df6dc1 100644 --- a/doc/source/reference_manual/csresmap.rst +++ b/doc/source/users/reference_manual/csresmap.rst diff --git a/doc/source/reference_manual/cssens.rst b/doc/source/users/reference_manual/cssens.rst index bf22f90..bf22f90 100644 --- a/doc/source/reference_manual/cssens.rst +++ b/doc/source/users/reference_manual/cssens.rst diff --git a/doc/source/reference_manual/csspec.rst b/doc/source/users/reference_manual/csspec.rst index 4a8e55d..4a8e55d 100644 --- a/doc/source/reference_manual/csspec.rst +++ b/doc/source/users/reference_manual/csspec.rst diff --git a/doc/source/reference_manual/cstsdist.rst b/doc/source/users/reference_manual/cstsdist.rst index aa705dd..aa705dd 100644 --- a/doc/source/reference_manual/cstsdist.rst +++ b/doc/source/users/reference_manual/cstsdist.rst diff --git a/doc/source/reference_manual/cstsmapmerge.rst b/doc/source/users/reference_manual/cstsmapmerge.rst index 6b2256d..6b2256d 100644 --- a/doc/source/reference_manual/cstsmapmerge.rst +++ b/doc/source/users/reference_manual/cstsmapmerge.rst diff --git a/doc/source/reference_manual/ctbin.rst b/doc/source/users/reference_manual/ctbin.rst index e0bb555..e0bb555 100644 --- a/doc/source/reference_manual/ctbin.rst +++ b/doc/source/users/reference_manual/ctbin.rst diff --git a/doc/source/reference_manual/ctbkgcube.rst b/doc/source/users/reference_manual/ctbkgcube.rst index babe5cf..babe5cf 100644 --- a/doc/source/reference_manual/ctbkgcube.rst +++ b/doc/source/users/reference_manual/ctbkgcube.rst diff --git a/doc/source/reference_manual/ctbutterfly.rst b/doc/source/users/reference_manual/ctbutterfly.rst index cd8cbd2..cd8cbd2 100644 --- a/doc/source/reference_manual/ctbutterfly.rst +++ b/doc/source/users/reference_manual/ctbutterfly.rst diff --git a/doc/source/reference_manual/ctcubemask.rst b/doc/source/users/reference_manual/ctcubemask.rst index 59fddd8..59fddd8 100644 --- a/doc/source/reference_manual/ctcubemask.rst +++ b/doc/source/users/reference_manual/ctcubemask.rst diff --git a/doc/source/reference_manual/ctedispcube.rst b/doc/source/users/reference_manual/ctedispcube.rst index bd9ff2b..bd9ff2b 100644 --- a/doc/source/reference_manual/ctedispcube.rst +++ b/doc/source/users/reference_manual/ctedispcube.rst diff --git a/doc/source/reference_manual/cterror.rst b/doc/source/users/reference_manual/cterror.rst index ac1d520..ac1d520 100644 --- a/doc/source/reference_manual/cterror.rst +++ b/doc/source/users/reference_manual/cterror.rst diff --git a/doc/source/reference_manual/ctexpcube.rst b/doc/source/users/reference_manual/ctexpcube.rst index 2855d63..2855d63 100644 --- a/doc/source/reference_manual/ctexpcube.rst +++ b/doc/source/users/reference_manual/ctexpcube.rst diff --git a/doc/source/reference_manual/ctlike.rst b/doc/source/users/reference_manual/ctlike.rst index 70dfc1f..70dfc1f 100644 --- a/doc/source/reference_manual/ctlike.rst +++ b/doc/source/users/reference_manual/ctlike.rst diff --git a/doc/source/reference_manual/ctmapcube.rst b/doc/source/users/reference_manual/ctmapcube.rst index f08ef8d..f08ef8d 100644 --- a/doc/source/reference_manual/ctmapcube.rst +++ b/doc/source/users/reference_manual/ctmapcube.rst diff --git a/doc/source/reference_manual/ctmodel.rst b/doc/source/users/reference_manual/ctmodel.rst index 7a356c1..7a356c1 100644 --- a/doc/source/reference_manual/ctmodel.rst +++ b/doc/source/users/reference_manual/ctmodel.rst diff --git a/doc/source/reference_manual/ctobssim.rst b/doc/source/users/reference_manual/ctobssim.rst index 2c021d2..2c021d2 100644 --- a/doc/source/reference_manual/ctobssim.rst +++ b/doc/source/users/reference_manual/ctobssim.rst diff --git a/doc/source/reference_manual/ctpsfcube.rst b/doc/source/users/reference_manual/ctpsfcube.rst index 14d30e6..14d30e6 100644 --- a/doc/source/reference_manual/ctpsfcube.rst +++ b/doc/source/users/reference_manual/ctpsfcube.rst diff --git a/doc/source/reference_manual/ctselect.rst b/doc/source/users/reference_manual/ctselect.rst index 7e281f1..7e281f1 100644 --- a/doc/source/reference_manual/ctselect.rst +++ b/doc/source/users/reference_manual/ctselect.rst diff --git a/doc/source/reference_manual/ctskymap.rst b/doc/source/users/reference_manual/ctskymap.rst index e7abc02..e7abc02 100644 --- a/doc/source/reference_manual/ctskymap.rst +++ b/doc/source/users/reference_manual/ctskymap.rst diff --git a/doc/source/reference_manual/cttsmap.rst b/doc/source/users/reference_manual/cttsmap.rst index aa26737..aa26737 100644 --- a/doc/source/reference_manual/cttsmap.rst +++ b/doc/source/users/reference_manual/cttsmap.rst diff --git a/doc/source/reference_manual/ctulimit.rst b/doc/source/users/reference_manual/ctulimit.rst index 4ef7f43..4ef7f43 100644 --- a/doc/source/reference_manual/ctulimit.rst +++ b/doc/source/users/reference_manual/ctulimit.rst diff --git a/doc/source/reference_manual/index.rst b/doc/source/users/reference_manual/index.rst index b552245..c4c2108 100644 --- a/doc/source/reference_manual/index.rst +++ b/doc/source/users/reference_manual/index.rst @@ -33,8 +33,8 @@ ctools ctulimit --- Calculates upper limit -General cscripts ----------------- +cscripts +-------- .. toctree:: :maxdepth: 1 @@ -53,8 +53,8 @@ General cscripts cstsmapmerge --- Merges slices from ts map computations -IACT cscripts -------------- +Scripts to manage an IACT database +---------------------------------- .. toctree:: :maxdepth: 1 diff --git a/doc/source/reference_manual/usage.rst b/doc/source/users/reference_manual/usage.rst index 32e08b3..32e08b3 100644 --- a/doc/source/reference_manual/usage.rst +++ b/doc/source/users/reference_manual/usage.rst diff --git a/doc/source/user_manual/getting.rst b/doc/source/users/user_manual/getting.rst index 699e0c3..699e0c3 100644 --- a/doc/source/user_manual/getting.rst +++ b/doc/source/users/user_manual/getting.rst diff --git a/doc/source/user_manual/getting_started/beyond.rst b/doc/source/users/user_manual/getting_started/beyond.rst index 92225ab..92225ab 100644 --- a/doc/source/user_manual/getting_started/beyond.rst +++ b/doc/source/users/user_manual/getting_started/beyond.rst diff --git a/doc/source/user_manual/getting_started/beyond_combine.rst b/doc/source/users/user_manual/getting_started/beyond_combine.rst index 63cc418..63cc418 100644 --- a/doc/source/user_manual/getting_started/beyond_combine.rst +++ b/doc/source/users/user_manual/getting_started/beyond_combine.rst diff --git a/doc/source/user_manual/getting_started/beyond_irf.rst b/doc/source/users/user_manual/getting_started/beyond_irf.rst index 2275168..2275168 100644 --- a/doc/source/user_manual/getting_started/beyond_irf.rst +++ b/doc/source/users/user_manual/getting_started/beyond_irf.rst diff --git a/doc/source/user_manual/getting_started/beyond_model.rst b/doc/source/users/user_manual/getting_started/beyond_model.rst index 2db8335..2db8335 100644 --- a/doc/source/user_manual/getting_started/beyond_model.rst +++ b/doc/source/users/user_manual/getting_started/beyond_model.rst diff --git a/doc/source/user_manual/getting_started/beyond_residual.rst b/doc/source/users/user_manual/getting_started/beyond_residual.rst index aa8749e..aa8749e 100644 --- a/doc/source/user_manual/getting_started/beyond_residual.rst +++ b/doc/source/users/user_manual/getting_started/beyond_residual.rst diff --git a/doc/source/user_manual/getting_started/beyond_stacked.rst b/doc/source/users/user_manual/getting_started/beyond_stacked.rst index 537d443..537d443 100644 --- a/doc/source/user_manual/getting_started/beyond_stacked.rst +++ b/doc/source/users/user_manual/getting_started/beyond_stacked.rst diff --git a/doc/source/user_manual/getting_started/beyond_tsmap.rst b/doc/source/users/user_manual/getting_started/beyond_tsmap.rst index 6d5bd17..6d5bd17 100644 --- a/doc/source/user_manual/getting_started/beyond_tsmap.rst +++ b/doc/source/users/user_manual/getting_started/beyond_tsmap.rst diff --git a/doc/source/user_manual/getting_started/binning.rst b/doc/source/users/user_manual/getting_started/binning.rst index 35fac63..35fac63 100644 --- a/doc/source/user_manual/getting_started/binning.rst +++ b/doc/source/users/user_manual/getting_started/binning.rst diff --git a/doc/source/user_manual/getting_started/butterfly.jpg b/doc/source/users/user_manual/getting_started/butterfly.jpg index 814edc1..814edc1 100644 --- a/doc/source/user_manual/getting_started/butterfly.jpg +++ b/doc/source/users/user_manual/getting_started/butterfly.jpg diff --git a/doc/source/user_manual/getting_started/butterfly.rst b/doc/source/users/user_manual/getting_started/butterfly.rst index 26b2b02..26b2b02 100644 --- a/doc/source/user_manual/getting_started/butterfly.rst +++ b/doc/source/users/user_manual/getting_started/butterfly.rst diff --git a/doc/source/user_manual/getting_started/cntmap-fits.jpg b/doc/source/users/user_manual/getting_started/cntmap-fits.jpg index f9c73aa..f9c73aa 100644 --- a/doc/source/user_manual/getting_started/cntmap-fits.jpg +++ b/doc/source/users/user_manual/getting_started/cntmap-fits.jpg diff --git a/doc/source/user_manual/getting_started/cntmap-map.jpg b/doc/source/users/user_manual/getting_started/cntmap-map.jpg index b22de89..b22de89 100644 --- a/doc/source/user_manual/getting_started/cntmap-map.jpg +++ b/doc/source/users/user_manual/getting_started/cntmap-map.jpg diff --git a/doc/source/user_manual/getting_started/dskeys.jpg b/doc/source/users/user_manual/getting_started/dskeys.jpg index 0185466..0185466 100644 --- a/doc/source/user_manual/getting_started/dskeys.jpg +++ b/doc/source/users/user_manual/getting_started/dskeys.jpg diff --git a/doc/source/user_manual/getting_started/fitting.rst b/doc/source/users/user_manual/getting_started/fitting.rst index 43e05ad..43e05ad 100644 --- a/doc/source/user_manual/getting_started/fitting.rst +++ b/doc/source/users/user_manual/getting_started/fitting.rst diff --git a/doc/source/user_manual/getting_started/index.rst b/doc/source/users/user_manual/getting_started/index.rst index 57b6851..57b6851 100644 --- a/doc/source/user_manual/getting_started/index.rst +++ b/doc/source/users/user_manual/getting_started/index.rst diff --git a/doc/source/user_manual/getting_started/irf-aeff.png b/doc/source/users/user_manual/getting_started/irf-aeff.png index eabbe69..eabbe69 100644 --- a/doc/source/user_manual/getting_started/irf-aeff.png +++ b/doc/source/users/user_manual/getting_started/irf-aeff.png diff --git a/doc/source/user_manual/getting_started/irf-file.png b/doc/source/users/user_manual/getting_started/irf-file.png index 31f1599..31f1599 100644 --- a/doc/source/user_manual/getting_started/irf-file.png +++ b/doc/source/users/user_manual/getting_started/irf-file.png diff --git a/doc/source/user_manual/getting_started/irfs.jpg b/doc/source/users/user_manual/getting_started/irfs.jpg index c60bb63..c60bb63 100644 --- a/doc/source/user_manual/getting_started/irfs.jpg +++ b/doc/source/users/user_manual/getting_started/irfs.jpg diff --git a/doc/source/user_manual/getting_started/models.rst b/doc/source/users/user_manual/getting_started/models.rst index 93614d3..93614d3 100644 --- a/doc/source/user_manual/getting_started/models.rst +++ b/doc/source/users/user_manual/getting_started/models.rst diff --git a/doc/source/user_manual/getting_started/python.rst b/doc/source/users/user_manual/getting_started/python.rst index 49b1638..49b1638 100644 --- a/doc/source/user_manual/getting_started/python.rst +++ b/doc/source/users/user_manual/getting_started/python.rst diff --git a/doc/source/user_manual/getting_started/quickstart.rst b/doc/source/users/user_manual/getting_started/quickstart.rst index 5e8cc69..5e8cc69 100644 --- a/doc/source/user_manual/getting_started/quickstart.rst +++ b/doc/source/users/user_manual/getting_started/quickstart.rst diff --git a/doc/source/user_manual/getting_started/resmap-bkg.png b/doc/source/users/user_manual/getting_started/resmap-bkg.png index bb5d85e..bb5d85e 100644 --- a/doc/source/user_manual/getting_started/resmap-bkg.png +++ b/doc/source/users/user_manual/getting_started/resmap-bkg.png diff --git a/doc/source/user_manual/getting_started/resmap-crab.png b/doc/source/users/user_manual/getting_started/resmap-crab.png index a5840fb..a5840fb 100644 --- a/doc/source/user_manual/getting_started/resmap-crab.png +++ b/doc/source/users/user_manual/getting_started/resmap-crab.png diff --git a/doc/source/user_manual/getting_started/response.rst b/doc/source/users/user_manual/getting_started/response.rst index b0213c8..b0213c8 100644 --- a/doc/source/user_manual/getting_started/response.rst +++ b/doc/source/users/user_manual/getting_started/response.rst diff --git a/doc/source/user_manual/getting_started/simulating.rst b/doc/source/users/user_manual/getting_started/simulating.rst index 32d42c5..32d42c5 100644 --- a/doc/source/user_manual/getting_started/simulating.rst +++ b/doc/source/users/user_manual/getting_started/simulating.rst diff --git a/doc/source/user_manual/getting_started/tsmap-crab.png b/doc/source/users/user_manual/getting_started/tsmap-crab.png index 5af71f6..5af71f6 100644 --- a/doc/source/user_manual/getting_started/tsmap-crab.png +++ b/doc/source/users/user_manual/getting_started/tsmap-crab.png diff --git a/doc/source/user_manual/getting_started/unbinned.rst b/doc/source/users/user_manual/getting_started/unbinned.rst index 636758e..636758e 100644 --- a/doc/source/user_manual/getting_started/unbinned.rst +++ b/doc/source/users/user_manual/getting_started/unbinned.rst diff --git a/doc/source/user_manual/glossary.rst b/doc/source/users/user_manual/glossary.rst index 2a10e51..2a10e51 100644 --- a/doc/source/user_manual/glossary.rst +++ b/doc/source/users/user_manual/glossary.rst diff --git a/doc/source/user_manual/iact_analysis/analysis.rst b/doc/source/users/user_manual/iact_analysis/analysis.rst index b599678..b599678 100644 --- a/doc/source/user_manual/iact_analysis/analysis.rst +++ b/doc/source/users/user_manual/iact_analysis/analysis.rst diff --git a/doc/source/user_manual/iact_analysis/copy.rst b/doc/source/users/user_manual/iact_analysis/copy.rst index e8e3dd8..e8e3dd8 100644 --- a/doc/source/user_manual/iact_analysis/copy.rst +++ b/doc/source/users/user_manual/iact_analysis/copy.rst diff --git a/doc/source/user_manual/iact_analysis/high_level.rst b/doc/source/users/user_manual/iact_analysis/high_level.rst index 2c5bb98..2c5bb98 100644 --- a/doc/source/user_manual/iact_analysis/high_level.rst +++ b/doc/source/users/user_manual/iact_analysis/high_level.rst diff --git a/doc/source/user_manual/iact_analysis/index.rst b/doc/source/users/user_manual/iact_analysis/index.rst index 5c98063..5c98063 100644 --- a/doc/source/user_manual/iact_analysis/index.rst +++ b/doc/source/users/user_manual/iact_analysis/index.rst diff --git a/doc/source/user_manual/iact_analysis/simulation.rst b/doc/source/users/user_manual/iact_analysis/simulation.rst index f50fb51..f50fb51 100644 --- a/doc/source/user_manual/iact_analysis/simulation.rst +++ b/doc/source/users/user_manual/iact_analysis/simulation.rst diff --git a/doc/source/user_manual/iact_analysis/tips.rst b/doc/source/users/user_manual/iact_analysis/tips.rst index db0a71d..db0a71d 100644 --- a/doc/source/user_manual/iact_analysis/tips.rst +++ b/doc/source/users/user_manual/iact_analysis/tips.rst diff --git a/doc/source/user_manual/index.rst b/doc/source/users/user_manual/index.rst index 5d97ec0..5d97ec0 100644 --- a/doc/source/user_manual/index.rst +++ b/doc/source/users/user_manual/index.rst diff --git a/doc/source/user_manual/introduction.rst b/doc/source/users/user_manual/introduction.rst index 5f2367f..5f2367f 100644 --- a/doc/source/user_manual/introduction.rst +++ b/doc/source/users/user_manual/introduction.rst diff --git a/doc/source/user_manual/plotting.rst b/doc/source/users/user_manual/plotting.rst index bbf6abf..bbf6abf 100644 --- a/doc/source/user_manual/plotting.rst +++ b/doc/source/users/user_manual/plotting.rst