Skip to content

Commit 7f3f047

Browse files
emjay0921emjay0921
committed
chore: add missing README.rst for spp_api_v2_simulation, spp_statistic, spp_statistic_studio
These modules have DESCRIPTION.md files but their generated README.rst files were not committed, causing CI check-in step to fail.
1 parent e697aaa commit 7f3f047

3 files changed

Lines changed: 385 additions & 0 deletions

File tree

‎spp_api_v2_simulation/README.rst‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
======================
2+
OpenSPP Simulation API
3+
======================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:341a99619ee4fc6dc0669b84803de47b0cf14405275a60681952e5cf1eb6025f
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Production/Stable
16+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_simulation
21+
:alt: OpenSPP/OpenSPP2
22+
23+
|badge1| |badge2| |badge3|
24+
25+
FastAPI-based REST endpoints for simulation scenario management,
26+
execution, comparison, and population aggregation. Provides external
27+
systems (dashboards, mobile apps, third-party tools) programmatic access
28+
to the simulation and analytics engine.
29+
30+
Key Capabilities
31+
~~~~~~~~~~~~~~~~
32+
33+
- CRUD operations on simulation scenarios with entitlement rules
34+
- Execute simulations and retrieve run results (distribution, fairness,
35+
geographic data)
36+
- Compare multiple simulation runs side-by-side with overlap analysis
37+
- Compute population aggregation with demographic breakdowns via the
38+
aggregation engine
39+
- List available demographic dimensions and scenario templates
40+
- Convert simulation scenarios to real programs
41+
42+
API Endpoints
43+
~~~~~~~~~~~~~
44+
45+
+--------+-----------------------------+-----------------------------+
46+
| Method | Path | Description |
47+
+========+=============================+=============================+
48+
| GET | ``/simulation/scenarios`` | List scenarios |
49+
+--------+-----------------------------+-----------------------------+
50+
| POST | ``/simulation/scenarios`` | Create scenario |
51+
+--------+-----------------------------+-----------------------------+
52+
| GET | ``/ | Get scenario details |
53+
| | simulation/scenarios/{id}`` | |
54+
+--------+-----------------------------+-----------------------------+
55+
| PUT | ``/ | Update draft scenario |
56+
| | simulation/scenarios/{id}`` | |
57+
+--------+-----------------------------+-----------------------------+
58+
| DELETE | ``/ | Archive scenario |
59+
| | simulation/scenarios/{id}`` | |
60+
+--------+-----------------------------+-----------------------------+
61+
| POST | ``/simula | Mark scenario ready |
62+
| | tion/scenarios/{id}/ready`` | |
63+
+--------+-----------------------------+-----------------------------+
64+
| POST | ``/simu | Execute simulation |
65+
| | lation/scenarios/{id}/run`` | |
66+
+--------+-----------------------------+-----------------------------+
67+
| POST | ``/simulation/scenario | Convert to program |
68+
| | s/{id}/convert-to-program`` | |
69+
+--------+-----------------------------+-----------------------------+
70+
| GET | ``/simulation/runs`` | List runs |
71+
+--------+-----------------------------+-----------------------------+
72+
| GET | ``/simulation/runs/{id}`` | Get run with optional |
73+
| | | details |
74+
+--------+-----------------------------+-----------------------------+
75+
| POST | ``/simulation/comparisons`` | Create run comparison |
76+
+--------+-----------------------------+-----------------------------+
77+
| GET | ``/si | Get comparison |
78+
| | mulation/comparisons/{id}`` | |
79+
+--------+-----------------------------+-----------------------------+
80+
| GET | ``/simulation/templates`` | List scenario templates |
81+
+--------+-----------------------------+-----------------------------+
82+
| POST | ``/aggregation/compute`` | Compute population |
83+
| | | aggregation |
84+
+--------+-----------------------------+-----------------------------+
85+
| GET | ``/aggregation/dimensions`` | List demographic dimensions |
86+
+--------+-----------------------------+-----------------------------+
87+
88+
OAuth Scopes
89+
~~~~~~~~~~~~
90+
91+
====================== ====================================
92+
Scope Operations
93+
====================== ====================================
94+
``simulation:read`` List/get scenarios, runs, templates
95+
``simulation:write`` Create/update/archive scenarios
96+
``simulation:execute`` Run simulations
97+
``simulation:convert`` Convert scenario to program
98+
``aggregation:read`` Compute aggregation, list dimensions
99+
====================== ====================================
100+
101+
UI Location
102+
~~~~~~~~~~~
103+
104+
No standalone menu; API-only module.
105+
106+
Dependencies
107+
~~~~~~~~~~~~
108+
109+
``spp_api_v2``, ``spp_simulation``, ``spp_aggregation``
110+
111+
**Table of contents**
112+
113+
.. contents::
114+
:local:
115+
116+
Bug Tracker
117+
===========
118+
119+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
120+
In case of trouble, please check there if your issue has already been reported.
121+
If you spotted it first, help us to smash it by providing a detailed and welcomed
122+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_api_v2_simulation%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
123+
124+
Do not contact contributors directly about support or help with technical issues.
125+
126+
Credits
127+
=======
128+
129+
Authors
130+
-------
131+
132+
* OpenSPP.org
133+
134+
Maintainers
135+
-----------
136+
137+
.. |maintainer-jeremi| image:: https://github.com/jeremi.png?size=40px
138+
:target: https://github.com/jeremi
139+
:alt: jeremi
140+
.. |maintainer-gonzalesedwin1123| image:: https://github.com/gonzalesedwin1123.png?size=40px
141+
:target: https://github.com/gonzalesedwin1123
142+
:alt: gonzalesedwin1123
143+
.. |maintainer-reichie020212| image:: https://github.com/reichie020212.png?size=40px
144+
:target: https://github.com/reichie020212
145+
:alt: reichie020212
146+
147+
Current maintainers:
148+
149+
|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-reichie020212|
150+
151+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_simulation>`_ project on GitHub.
152+
153+
You are welcome to contribute.

‎spp_statistic/README.rst‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
==================
2+
OpenSPP Statistics
3+
==================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:7a18b540da680b64fe34c40ba13b6177cd957e3ccb919034b0fafdfa74d4339f
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Alpha
16+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_statistic
21+
:alt: OpenSPP/OpenSPP2
22+
23+
|badge1| |badge2| |badge3|
24+
25+
Publishable statistics layer that connects CEL variables to presentation
26+
contexts (GIS maps, dashboards, APIs, reports). Each statistic wraps a
27+
CEL variable with format, privacy thresholds, and per-context overrides
28+
so a single computation can be published in multiple places with
29+
different labels and suppression rules.
30+
31+
Key Capabilities
32+
~~~~~~~~~~~~~~~~
33+
34+
- Bind a CEL variable to one or more publication channels (GIS,
35+
dashboard, API, report)
36+
- Apply k-anonymity small-cell suppression with configurable thresholds
37+
per context
38+
- Override labels, formats, icons, and color thresholds for each
39+
publication context
40+
- Query published statistics by context and category
41+
- Serialize statistics to dictionaries for API and UI consumption
42+
43+
Key Models
44+
~~~~~~~~~~
45+
46+
+---------------------------+-----------------------------------------+
47+
| Model | Description |
48+
+===========================+=========================================+
49+
| ``spp.statistic`` | A publishable statistic linked to a CEL |
50+
| | variable |
51+
+---------------------------+-----------------------------------------+
52+
| ``spp.statistic.context`` | Per-context presentation and privacy |
53+
| | overrides |
54+
+---------------------------+-----------------------------------------+
55+
56+
Configuration
57+
~~~~~~~~~~~~~
58+
59+
After installing:
60+
61+
1. Create statistics via the Studio UI (requires
62+
``spp_statistic_studio``) or programmatically
63+
2. Link each statistic to an active CEL variable
64+
3. Enable publication flags (``is_published_gis``,
65+
``is_published_dashboard``, etc.)
66+
4. Optionally add context-specific overrides for label, format, and
67+
suppression threshold
68+
69+
UI Location
70+
~~~~~~~~~~~
71+
72+
No standalone menu; configuration UI is provided by
73+
``spp_statistic_studio``.
74+
75+
Security
76+
~~~~~~~~
77+
78+
================================ =========
79+
Group Access
80+
================================ =========
81+
``base.group_user`` Read
82+
``spp_security.group_spp_admin`` Full CRUD
83+
================================ =========
84+
85+
Extension Points
86+
~~~~~~~~~~~~~~~~
87+
88+
- Override ``apply_suppression()`` to implement custom privacy rules
89+
- Override ``get_context_config()`` to add context-specific logic
90+
- Inherit ``spp.statistic`` to add domain-specific publication flags
91+
92+
Dependencies
93+
~~~~~~~~~~~~
94+
95+
``spp_cel_domain``, ``spp_metrics_core``, ``spp_security``
96+
97+
.. IMPORTANT::
98+
This is an alpha version, the data model and design can change at any time without warning.
99+
Only for development or testing purpose, do not use in production.
100+
101+
**Table of contents**
102+
103+
.. contents::
104+
:local:
105+
106+
Bug Tracker
107+
===========
108+
109+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
110+
In case of trouble, please check there if your issue has already been reported.
111+
If you spotted it first, help us to smash it by providing a detailed and welcomed
112+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_statistic%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
113+
114+
Do not contact contributors directly about support or help with technical issues.
115+
116+
Credits
117+
=======
118+
119+
Authors
120+
-------
121+
122+
* OpenSPP.org
123+
124+
Maintainers
125+
-----------
126+
127+
.. |maintainer-jeremi| image:: https://github.com/jeremi.png?size=40px
128+
:target: https://github.com/jeremi
129+
:alt: jeremi
130+
.. |maintainer-gonzalesedwin1123| image:: https://github.com/gonzalesedwin1123.png?size=40px
131+
:target: https://github.com/gonzalesedwin1123
132+
:alt: gonzalesedwin1123
133+
134+
Current maintainers:
135+
136+
|maintainer-jeremi| |maintainer-gonzalesedwin1123|
137+
138+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_statistic>`_ project on GitHub.
139+
140+
You are welcome to contribute.

‎spp_statistic_studio/README.rst‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
=========================
2+
OpenSPP Statistics Studio
3+
=========================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:89544c4d97fc4199ac6b8872bc737c9ef0ee2e07cc353b94bedf6c382620716b
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Beta
16+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_statistic_studio
21+
:alt: OpenSPP/OpenSPP2
22+
23+
|badge1| |badge2| |badge3|
24+
25+
Bridge module that exposes statistics configuration in the Studio
26+
no-code UI. Auto-installs when both ``spp_statistic`` and ``spp_studio``
27+
are present. Adds tree/form views for statistics and metric categories
28+
under the Studio settings menu.
29+
30+
Key Capabilities
31+
~~~~~~~~~~~~~~~~
32+
33+
- Manage statistics (create, edit, archive) through Studio forms
34+
- Manage metric categories through Studio forms
35+
- Grants Studio managers full CRUD on statistics, contexts, and
36+
categories
37+
38+
Key Models
39+
~~~~~~~~~~
40+
41+
No new models. Provides views and menu entries for ``spp.statistic``,
42+
``spp.statistic.context``, and ``spp.metric.category``.
43+
44+
UI Location
45+
~~~~~~~~~~~
46+
47+
- **Menu**: Studio > Settings > Statistics > All Statistics
48+
- **Menu**: Studio > Settings > Statistics > Categories
49+
50+
Security
51+
~~~~~~~~
52+
53+
=================================== =========
54+
Group Access
55+
=================================== =========
56+
``spp_studio.group_studio_manager`` Full CRUD
57+
=================================== =========
58+
59+
Dependencies
60+
~~~~~~~~~~~~
61+
62+
``spp_statistic``, ``spp_studio``
63+
64+
**Table of contents**
65+
66+
.. contents::
67+
:local:
68+
69+
Bug Tracker
70+
===========
71+
72+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
73+
In case of trouble, please check there if your issue has already been reported.
74+
If you spotted it first, help us to smash it by providing a detailed and welcomed
75+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_statistic_studio%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
76+
77+
Do not contact contributors directly about support or help with technical issues.
78+
79+
Credits
80+
=======
81+
82+
Authors
83+
-------
84+
85+
* OpenSPP.org
86+
87+
Maintainers
88+
-----------
89+
90+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_statistic_studio>`_ project on GitHub.
91+
92+
You are welcome to contribute.

0 commit comments

Comments
 (0)