Commit 274b77f2 authored by Davide Ricci's avatar Davide Ricci
Browse files
parents 28b49d40 8364a2f8
Loading
Loading
Loading
Loading
+2 −2
Changes for .gitlab-ci.yml: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -97,12 +97,12 @@ pages:
#    - apt-get update -y && apt install -y gnuplot
    - pip install --upgrade pip
#    - pip install gnuplotlib
    - pip install setuptools pyvantagepro sphinx
    - pip install setuptools sphinx
    - pip install -e .
    - pip install -r docs/requirements.txt
  script:
    - cp noctua/config/nodes.ini.template noctua/config/nodes.ini
    - sphinx-apidoc -o docs/source ${PROJECT}
    - sphinx-apidoc -f -o docs/source ${PROJECT}
    - sphinx-build -b html docs/source public
  artifacts:
    paths:
+14 −7
Changes for README.md: 14 added lines, 7 removed lines.
Original line number Diff line number Diff line
@@ -30,15 +30,22 @@ To install the dependencies:
pip install -e .
```

In particular, for the core routines:
`requests loguru astropy` and
`gnuplotlib pyvantagepro`, that will be soon removed.
The full list is in `pyproject.toml`. In particular:

For the API:
`flask==3.0.2 werkzeug-3.0.1 flask-restx==1.3.0`, that will be soon replaced by `quart`
- core routines: `requests loguru astropy numpy numba telnetlib3 httpx`
- API and web interface: `quart quart_cors uvicorn websockets`
- device SDKs: `PIPython` (PI controllers), `vmbpy` (Allied Vision
  Mako, wheel in `lib/`).

For the web interface:
`flask==3.0.2 werkzeug-3.0.1 flask-socketio==5.3.6 flask-httpauth==4.8.0`
The Atik Python SDK used by `devices/atik.py` is not installed by
`pip install -e .`:

```
pip install lib/Atik_Python_SDK-1.5.1-py3-none-any.whl
```

The system libraries of the camera SDKs (Vimba X, Atik) are installed
with `noctua-install-system` (needs sudo).


## Add the nodes of your observatory:
+157 −0
Changes for docs/source/noctua.api.rst: 157 added lines, 0 removed lines.
Original line number Diff line number Diff line
noctua.api package
==================

Submodules
----------

noctua.api.basecontext module
-----------------------------

.. automodule:: noctua.api.basecontext
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.baseresource module
------------------------------

.. automodule:: noctua.api.baseresource
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.blocks module
------------------------

.. automodule:: noctua.api.blocks
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.camera module
------------------------

.. automodule:: noctua.api.camera
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.defaults module
--------------------------

.. automodule:: noctua.api.defaults
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.deps module
----------------------

.. automodule:: noctua.api.deps
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.dome module
----------------------

.. automodule:: noctua.api.dome
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.fits\_image module
-----------------------------

.. automodule:: noctua.api.fits_image
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.focuser module
-------------------------

.. automodule:: noctua.api.focuser
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.guider module
------------------------

.. automodule:: noctua.api.guider
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.guider\_instance module
----------------------------------

.. automodule:: noctua.api.guider_instance
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.rotator module
-------------------------

.. automodule:: noctua.api.rotator
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.sequencer module
---------------------------

.. automodule:: noctua.api.sequencer
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.sequencer\_instance module
-------------------------------------

.. automodule:: noctua.api.sequencer_instance
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.stage module
-----------------------

.. automodule:: noctua.api.stage
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.switch module
------------------------

.. automodule:: noctua.api.switch
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.telescope module
---------------------------

.. automodule:: noctua.api.telescope
   :members:
   :show-inheritance:
   :undoc-members:

noctua.api.webcam module
------------------------

.. automodule:: noctua.api.webcam
   :members:
   :show-inheritance:
   :undoc-members:

Module contents
---------------

.. automodule:: noctua.api
   :members:
   :show-inheritance:
   :undoc-members:
+31 −7
Changes for docs/source/noctua.devices.rst: 31 added lines, 7 removed lines.
Original line number Diff line number Diff line
@@ -20,6 +20,14 @@ noctua.devices.astelco module
   :show-inheritance:
   :undoc-members:

noctua.devices.atik module
--------------------------

.. automodule:: noctua.devices.atik
   :members:
   :show-inheritance:
   :undoc-members:

noctua.devices.basedevice module
--------------------------------

@@ -44,10 +52,26 @@ noctua.devices.ipcam module
   :show-inheritance:
   :undoc-members:

noctua.devices.meteo module
noctua.devices.mako module
--------------------------

.. automodule:: noctua.devices.mako
   :members:
   :show-inheritance:
   :undoc-members:

noctua.devices.mercury module
-----------------------------

.. automodule:: noctua.devices.mercury
   :members:
   :show-inheritance:
   :undoc-members:

noctua.devices.netio module
---------------------------

.. automodule:: noctua.devices.meteo
.. automodule:: noctua.devices.netio
   :members:
   :show-inheritance:
   :undoc-members:
@@ -60,18 +84,18 @@ noctua.devices.siemens module
   :show-inheritance:
   :undoc-members:

noctua.devices.stx module
noctua.devices.stl module
-------------------------

.. automodule:: noctua.devices.stx
.. automodule:: noctua.devices.stl
   :members:
   :show-inheritance:
   :undoc-members:

noctua.devices.stx2 module
--------------------------
noctua.devices.stx module
-------------------------

.. automodule:: noctua.devices.stx2
.. automodule:: noctua.devices.stx
   :members:
   :show-inheritance:
   :undoc-members:
+18 −0
Changes for docs/source/noctua.rst: 18 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -7,14 +7,32 @@ Subpackages
.. toctree::
   :maxdepth: 4

   noctua.api
   noctua.config
   noctua.devices
   noctua.templates
   noctua.utils
   noctua.web

Submodules
----------

noctua.app module
-----------------

.. automodule:: noctua.app
   :members:
   :show-inheritance:
   :undoc-members:

noctua.guider module
--------------------

.. automodule:: noctua.guider
   :members:
   :show-inheritance:
   :undoc-members:

noctua.sequencer module
-----------------------

Loading