Skip to content

Commit

Permalink
Merge pull request #253 from Ouranosinc/fix-250
Browse files Browse the repository at this point in the history
Remove obsolete documentation
  • Loading branch information
huard authored Apr 4, 2022
2 parents 98dc3a5 + ceafc5e commit e8baa96
Show file tree
Hide file tree
Showing 16 changed files with 11 additions and 294 deletions.
24 changes: 0 additions & 24 deletions docs/source/arch/data_catalog.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/source/arch/frontend.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/source/arch/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,3 @@ System Architecture
overview
backend
jupyter
frontend
data_catalog
12 changes: 5 additions & 7 deletions docs/source/arch/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,25 +28,23 @@ Raven
JupyterLab
A notebook interface to demonstrate how WPS services can be used from a programming environment.

PAVICS-frontend
The user interface (UI) handling user accounts, workspace, workflows and data visualization. Development of the UI has paused as it consumed a lot of resources, consider it as a prototype.

PAVICS-DataCatalog
Storing and serving information about available climate data.

Magpie
Authentication and authorization services.

Weaver
Workflow Execution Management Service (EMS) and Application, Deployment and Execution Service (ADES) supporting legacy WPS services as well as OGC API - Processes REST bindings.

THREDDS
netCDF data server.

GeoServer
Geospatial data server.



These components work together to offer users a seamless access to data and a suite of services that can convert raw climate data into useful information, graphics and tables.


Credits
-------
PAVICS is led by `Ouranos <https://www.ouranos.ca/en/>`_, a regional climatology research consortium, and `CRIM <http://www.crim.ca/fr>`_, an informatics and software research institute, (both located in Montreal, Quebec, Canada) to provide climate scientists with a set of tools to acquire and analyze climate data. The project was funded by the CANARIE research software program.
PAVICS is led by `Ouranos <https://www.ouranos.ca/en/>`_, a regional climatology research consortium, and `CRIM <http://www.crim.ca/fr>`_, an informatics and software research institute, (both located in Montreal, Quebec, Canada) to provide climate scientists with a set of tools to acquire and analyze climate data. The project was initially funded by the CANARIE research software program, and has since benefited from contributions from the Open Geospatial Consortium, the Québec Ministry of Environment and Fight Against Climate Change, Environment and Climate Change Canada and the Canadian Foundation for Innovation.
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel',
'sphinx-jsonschema',
'nbsphinx',
]

Expand Down
59 changes: 0 additions & 59 deletions docs/source/gui/frontend.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/gui/index.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ We plan to build extensive documentation for PAVICS. We're just getting started,

* :doc:`Processes </processes/index>` documents all available processes on the PAVICS platform.

* :doc:`Graphical User Interface </gui/index>` walks you through the components of the web browser frontend.


.. _issue tracker: https://github.com/Ouranosinc/pavics-sdi/issues
.. _birdhouse: http://bird-house.github.io/
Expand All @@ -38,9 +36,7 @@ Contents
tutorials/index
notebooks/index
processes/index
workflows/index
projects/index
gui/index
dev/index
arch/index
provenance/index
Expand Down
18 changes: 5 additions & 13 deletions docs/source/provenance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,17 @@
Provenance
==========

The code base is divided into multiple components each having its own release schedule. Each component is stored on a
individual github repository, where every change of the master branch triggers a test suite run and a build of the
corresponding docker image (available on `DockerHub`_). Development occurs in code branches, and modifications are only
merged after code reviews have been completed and all tests passed. Official releases are tagged after significant code
changes and are authorized by ?. The project documentation is entirely contained within the various sections of this
document.

pavics-sdi is relying on a number of different packages developed by other teams. Minor pavics releases will be created following major releases of these critical third party packages if they do not coincide with a major internal release. Package whose upgrade whose trigger a minor pavics release include ocgis, flyingpigeon and malleefowl.

Ouranos deployment
------------------
A pre-release version is deployed on an experimental server and integration testing is performed to make sure the platform is in working order. If everything is in order, the pre-release version becomes the release version and is deployed on the pavics server.
Software
--------
The PAVICS platform relies on a number of independent components, each with its own release schedule. Each component that Ouranos and CRIM maintain is stored in an individual github repository, where every change of the master branch triggers a test suite run. Development occurs in code branches, and modifications are only merged after code reviews have been completed and all tests passed. Official releases are tagged after significant code changes and are authorized by each library's maintainer.

These releases are then deployed by updating the version of the docker image loaded by docker-compose in `birdhouse-deploy`_. Relevant changes are described in file :file:`CHANGES.md`. Pull requests trigger a test suite, where documentation and tutorial notebooks are executed against the platform and compare results with expected outputs.


.. todo::

Review by CRIM.


_`birdhouse-deploy`: https://github.com/bird-house/birdhouse-deploy

.. _DockerHub: https://hub.docker.com/
41 changes: 0 additions & 41 deletions docs/source/workflows/examples.rst

This file was deleted.

23 changes: 0 additions & 23 deletions docs/source/workflows/index.rst

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/workflows/schema.rst

This file was deleted.

69 changes: 0 additions & 69 deletions docs/source/workflows/vocabulary.rst

This file was deleted.

Loading

0 comments on commit e8baa96

Please sign in to comment.