Skip to content

Commit bc61ead

Browse files
BDonnotBDonnot
committed
improving doc
1 parent caf5e30 commit bc61ead

24 files changed

+523
-144
lines changed

‎docs/data_pipeline.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ Results are reported in the table below:
5555
============================== ================ ===================
5656
Method used memory footprint time to perform (s)
5757
============================== ================ ===================
58-
Nothing (see `Basic Usage`_) low 44.6
59-
set_chunk (see `Chunk size`_) ultra low 26.8
60-
`MultifolderWithCache`_ high 11.0
58+
Nothing (see Basic Usage ) low 44.6
59+
set_chunk (see `Chunk size`_ ) ultra low 26.8
60+
`MultifolderWithCache`_ high 11.0
6161
============================== ================ ===================
6262

6363
As you can see, the default usage uses relatively little memory but takes a while to compute (almost 45s to perform

‎docs/developer/create_an_environment.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. |l2rpn_case14_sandbox_layout| image:: ./img/l2rpn_case14_sandbox_layout.png
2-
.. |R2_full_grid| image:: ./img/R2_full_grid.png
3-
.. |l2rpn_neurips_2020_track1_layout| image:: ./img/l2rpn_neurips_2020_track1_layout.png
4-
.. |l2rpn_neurips_2020_track2_layout| image:: ./img/l2rpn_neurips_2020_track2_layout.png
5-
.. |l2rpn_wcci_2022_layout| image:: ./img/l2rpn_wcci_2022_layout.png
1+
.. |l2rpn_case14_sandbox_layout| image:: ../img/l2rpn_case14_sandbox_layout.png
2+
.. |R2_full_grid| image:: ../img/R2_full_grid.png
3+
.. |l2rpn_neurips_2020_track1_layout| image:: ../img/l2rpn_neurips_2020_track1_layout.png
4+
.. |l2rpn_neurips_2020_track2_layout| image:: ../img/l2rpn_neurips_2020_track2_layout.png
5+
.. |l2rpn_wcci_2022_layout| image:: ../img/l2rpn_wcci_2022_layout.png
66

77

88
Possible workflow to create an environment from existing time series

‎docs/developer/createbackend.rst‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,26 @@
2121
.. _line_or_pos_topo_vect: ./space.html#grid2op.Space.GridObjects.line_or_pos_topo_vect
2222
.. _line_ex_pos_topo_vect: ./space.html#grid2op.Space.GridObjects.line_ex_pos_topo_vect
2323

24-
.. |5subs_grid_layout| image:: ./img/5subs_grid_layout.jpg
25-
.. |5subs_grid_1_sub| image:: ./img/5subs_grid_1_sub.jpg
26-
.. |5subs_grid_2_loads| image:: ./img/5subs_grid_2_loads.jpg
27-
.. |5subs_grid_3_gens| image:: ./img/5subs_grid_3_gens.jpg
28-
.. |5subs_grid_4_lines| image:: ./img/5subs_grid_4_lines.jpg
29-
.. |5subs_grid_5_obj_in_sub| image:: ./img/5subs_grid_5_obj_in_sub.jpg
30-
.. |5subs_grid_layout_with_repr| image:: ./img/5subs_grid_layout_with_repr.jpg
31-
.. |5subs_grid_n_el| image:: ./img/5subs_grid_n_el.jpg
32-
.. |5subs_grid_5_sub_i| image:: ./img/5subs_grid_5_sub_i.jpg
33-
.. |5subs_grid_load_to_subid| image:: ./img/5subs_grid_load_to_subid.jpg
34-
.. |5subs_grid_el_to_subid| image:: ./img/5subs_grid_el_to_subid.jpg
35-
.. |5subs_grid_sub0| image:: ./img/5subs_grid_sub0.jpg
36-
.. |5subs_grid_sub0_final| image:: ./img/5subs_grid_sub0_final.jpg
37-
.. |5subs_grid_sub1_final| image:: ./img/5subs_grid_sub1_final.jpg
38-
.. |5subs_grid_loads_info| image:: ./img/5subs_grid_loads_info.jpg
39-
.. |5subs_grid_sub1_topo| image:: ./img/5subs_grid_sub1_topo.jpg
40-
.. |5subs_grid_sub1_2_topo| image:: ./img/5subs_grid_sub1_2_topo.jpg
41-
.. |5subs_grid_suball_topo| image:: ./img/5subs_grid_suball_topo.jpg
42-
.. |5subs_grid_ex_disco| image:: ./img/5subs_grid_ex_disco.jpg
43-
.. |5subs_grid_ex_2buses| image:: ./img/5subs_grid_ex_2buses.jpg
24+
.. |5subs_grid_layout| image:: ../img/5subs_grid_layout.jpg
25+
.. |5subs_grid_1_sub| image:: ../img/5subs_grid_1_sub.jpg
26+
.. |5subs_grid_2_loads| image:: ../img/5subs_grid_2_loads.jpg
27+
.. |5subs_grid_3_gens| image:: ../img/5subs_grid_3_gens.jpg
28+
.. |5subs_grid_4_lines| image:: ../img/5subs_grid_4_lines.jpg
29+
.. |5subs_grid_5_obj_in_sub| image:: ../img/5subs_grid_5_obj_in_sub.jpg
30+
.. |5subs_grid_layout_with_repr| image:: ../img/5subs_grid_layout_with_repr.jpg
31+
.. |5subs_grid_n_el| image:: ../img/5subs_grid_n_el.jpg
32+
.. |5subs_grid_5_sub_i| image:: ../img/5subs_grid_5_sub_i.jpg
33+
.. |5subs_grid_load_to_subid| image:: ../img/5subs_grid_load_to_subid.jpg
34+
.. |5subs_grid_el_to_subid| image:: ../img/5subs_grid_el_to_subid.jpg
35+
.. |5subs_grid_sub0| image:: ../img/5subs_grid_sub0.jpg
36+
.. |5subs_grid_sub0_final| image:: ../img/5subs_grid_sub0_final.jpg
37+
.. |5subs_grid_sub1_final| image:: ../img/5subs_grid_sub1_final.jpg
38+
.. |5subs_grid_loads_info| image:: ../img/5subs_grid_loads_info.jpg
39+
.. |5subs_grid_sub1_topo| image:: ../img/5subs_grid_sub1_topo.jpg
40+
.. |5subs_grid_sub1_2_topo| image:: ../img/5subs_grid_sub1_2_topo.jpg
41+
.. |5subs_grid_suball_topo| image:: ../img/5subs_grid_suball_topo.jpg
42+
.. |5subs_grid_ex_disco| image:: ../img/5subs_grid_ex_disco.jpg
43+
.. |5subs_grid_ex_2buses| image:: ../img/5subs_grid_ex_2buses.jpg
4444

4545
.. _create-backend-module:
4646

@@ -689,15 +689,16 @@ These functions can be used in the following manner:
689689
690690
And of course you do the same for generators and both ends of each powerline.
691691

692-
.. note:: About powerline, grid2op adopts the following convention: a powerline **cannot** be connected on one side
692+
.. note::
693+
About powerline, grid2op adopts the following convention: a powerline **cannot** be connected on one side
693694
and disconnected on the other.
694695

695696
That being said, it's still possible to connect the extremity of a powerline "alone" on a busbar, which will have
696697
the same effect of having it "disconnected at one ends only".
697698

698699
.. _vector-orders-create-backend:
699700

700-
***_infos() : Read back the results (flows, voltages etc.)
701+
\*\*\*_infos() : Read back the results (flows, voltages etc.)
701702
--------------------------------------------------------------
702703
This last "technical" part concerns what can be refer to as "getters" from the backend. These functions allow to
703704
read back the state of the grid and expose its results to grid2op in a standardize manner.

‎docs/developer/env_content.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
.. |l2rpn_case14_sandbox_layout| image:: ./img/l2rpn_case14_sandbox_layout.png
3-
.. |R2_full_grid| image:: ./img/R2_full_grid.png
4-
.. |l2rpn_neurips_2020_track1_layout| image:: ./img/l2rpn_neurips_2020_track1_layout.png
5-
.. |l2rpn_neurips_2020_track2_layout| image:: ./img/l2rpn_neurips_2020_track2_layout.png
6-
.. |l2rpn_wcci_2022_layout| image:: ./img/l2rpn_wcci_2022_layout.png
2+
.. |l2rpn_case14_sandbox_layout| image:: ../img/l2rpn_case14_sandbox_layout.png
3+
.. |R2_full_grid| image:: ../img/R2_full_grid.png
4+
.. |l2rpn_neurips_2020_track1_layout| image:: ../img/l2rpn_neurips_2020_track1_layout.png
5+
.. |l2rpn_neurips_2020_track2_layout| image:: ../img/l2rpn_neurips_2020_track2_layout.png
6+
.. |l2rpn_wcci_2022_layout| image:: ../img/l2rpn_wcci_2022_layout.png
77

88

99
Content of an environment

‎docs/grid2op_dev.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. toctree::
2+
:maxdepth: 1
3+
4+
grid2op_dev/action
5+
grid2op_dev/observation
6+
7+
.. include:: final.rst

‎docs/grid2op_dev/action.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
How to add a new type of action
2+
===================================
3+
4+
Work in progress !
5+
6+
7+
.. include:: final.rst

‎docs/grid2op_dev/observation.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
How to add a new attribute to the observation
2+
==============================================
3+
4+
Work in progress !
5+
6+
7+
.. include:: final.rst

‎docs/index.rst‎

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,14 +162,16 @@ deeply into the other section of the documentation.
162162

163163
user
164164

165-
External contribution technical Documentation
166-
------------------------------------------------
165+
166+
Technical documentation for grid2op "external" contributions
167+
----------------------------------------------------------------
167168

168169
This part of the documentation is focued on external contribution.
169170
It is best suited if you want to use grid2op as a "core" and extend / modify
170171
it with different elements.
171172

172173
For example, you might want to :
174+
173175
- use a different solver to compute powerflows
174176
(called :class:`grid2op.Backend.Backend` in grid2op)
175177
- create a new environment
@@ -185,18 +187,47 @@ are done internally whenever possible.
185187

186188
This is the type of documentation you should be looking at if the
187189
current grid2op modelling statisfies you in its vast majority
188-
but if you want to slightly modify one of its component
190+
but if you want to slightly modify one of its component.
191+
192+
.. note::
193+
This type of contribution can be developed and hosted in a different
194+
github repository than grid2op (*eg* lightsim2grid, another faster backend
195+
is hosted on https://github.com/bdonnot/lightsim2grid.git)
196+
197+
Feel free to contact us if you have done such an "external contribution" so
198+
that we can at least reference it in the documentation.
189199

190200
.. toctree::
191201
:maxdepth: 1
192-
:caption: Technical documentation for grid2op external contributors
202+
:caption: Technical documentation for grid2op "external" contributions
193203

194204
developer
195205

196-
Developer technical Documentation
197-
-----------------------------------
198206

207+
Technical documentation for grid2op developers
208+
-------------------------------------------------
209+
210+
This part of the documentation also focuses on external contribution. It
211+
focuses on the core of grid2op. If you want to :
212+
213+
- change the grid2op internal representation
214+
- add a functionality to grid2op (*eg* a new type of actions or a new attribute to the observation)
215+
- change the representatino of this or this elements
216+
- etc.
217+
218+
We encourage you to get in touch with us for such development.
219+
220+
.. note::
221+
Most of the work falling into this category should probably be
222+
integrated into the main grid2op repository.
223+
224+
.. warning::
225+
DOC IN PROGRESS...
226+
227+
.. toctree::
228+
:maxdepth: 1
229+
:caption: Technical documentation for grid2op developers
199230

200-
DOC IN PROGRESS...
231+
grid2op_dev
201232

202233
.. include:: final.rst

‎docs/mdp.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
.. include:: special.rst
1+
.. for the color
2+
.. include:: special.rst
23

4+
.. for the observation attributes
5+
.. include:: user/special.rst
6+
37
.. _mdp-doc-module:
48

59
Dive into grid2op sequential decision process

‎docs/special.rst‎

Lines changed: 1 addition & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -38,71 +38,4 @@
3838
.. role:: center
3939
.. role:: left
4040
.. role:: right
41-
.. (c) Lilian Besson, 2011-2016, https://bitbucket.org/lbesson/web-sphinx/
42-
43-
.. _n_gen: ./space.html#grid2op.Space.GridObjects.n_gen
44-
.. _n_load: ./space.html#grid2op.Space.GridObjects.n_load
45-
.. _n_line: ./space.html#grid2op.Space.GridObjects.n_line
46-
.. _n_sub: ./space.html#grid2op.Space.GridObjects.n_sub
47-
.. _n_storage: ./space.html#grid2op.Space.GridObjects.n_storage
48-
.. _dim_topo: ./space.html#grid2op.Space.GridObjects.dim_topo
49-
.. _dim_alarms: ./space.html#grid2op.Space.GridObjects.dim_alarms
50-
.. _dim_alerts: ./space.html#grid2op.Space.GridObjects.dim_alerts
51-
.. _year: ./observation.html#grid2op.Observation.BaseObservation.year
52-
.. _month: ./observation.html#grid2op.Observation.BaseObservation.month
53-
.. _day: ./observation.html#grid2op.Observation.BaseObservation.day
54-
.. _hour_of_day: ./observation.html#grid2op.Observation.BaseObservation.hour_of_day
55-
.. _minute_of_hour: ./observation.html#grid2op.Observation.BaseObservation.minute_of_hour
56-
.. _day_of_week: ./observation.html#grid2op.Observation.BaseObservation.day_of_week
57-
.. _gen_p: ./observation.html#grid2op.Observation.BaseObservation.gen_p
58-
.. _gen_q: ./observation.html#grid2op.Observation.BaseObservation.gen_q
59-
.. _gen_v: ./observation.html#grid2op.Observation.BaseObservation.gen_v
60-
.. _load_p: ./observation.html#grid2op.Observation.BaseObservation.load_p
61-
.. _load_q: ./observation.html#grid2op.Observation.BaseObservation.load_q
62-
.. _load_v: ./observation.html#grid2op.Observation.BaseObservation.load_v
63-
.. _p_or: ./observation.html#grid2op.Observation.BaseObservation.p_or
64-
.. _q_or: ./observation.html#grid2op.Observation.BaseObservation.q_or
65-
.. _v_or: ./observation.html#grid2op.Observation.BaseObservation.v_or
66-
.. _a_or: ./observation.html#grid2op.Observation.BaseObservation.a_or
67-
.. _p_ex: ./observation.html#grid2op.Observation.BaseObservation.p_ex
68-
.. _q_ex: ./observation.html#grid2op.Observation.BaseObservation.q_ex
69-
.. _v_ex: ./observation.html#grid2op.Observation.BaseObservation.v_ex
70-
.. _a_ex: ./observation.html#grid2op.Observation.BaseObservation.a_ex
71-
.. _rho: ./observation.html#grid2op.Observation.BaseObservation.rho
72-
.. _topo_vect: ./observation.html#grid2op.Observation.BaseObservation.topo_vect
73-
.. _line_status: ./observation.html#grid2op.Observation.BaseObservation.line_status
74-
.. _timestep_overflow: ./observation.html#grid2op.Observation.BaseObservation.timestep_overflow
75-
.. _time_before_cooldown_line: ./observation.html#grid2op.Observation.BaseObservation.time_before_cooldown_line
76-
.. _time_before_cooldown_sub: ./observation.html#grid2op.Observation.BaseObservation.time_before_cooldown_sub
77-
.. _time_next_maintenance: ./observation.html#grid2op.Observation.BaseObservation.time_next_maintenance
78-
.. _duration_next_maintenance: ./observation.html#grid2op.Observation.BaseObservation.duration_next_maintenance
79-
.. _target_dispatch: ./observation.html#grid2op.Observation.BaseObservation.target_dispatch
80-
.. _actual_dispatch: ./observation.html#grid2op.Observation.BaseObservation.actual_dispatch
81-
.. _storage_charge: ./observation.html#grid2op.Observation.BaseObservation.storage_charge
82-
.. _storage_power_target: ./observation.html#grid2op.Observation.BaseObservation.storage_power_target
83-
.. _storage_power: ./observation.html#grid2op.Observation.BaseObservation.storage_power
84-
.. _storage_theta: ./observation.html#grid2op.Observation.BaseObservation.storage_theta
85-
.. _gen_p_before_curtail: ./observation.html#grid2op.Observation.BaseObservation.gen_p_before_curtail
86-
.. _curtailment: ./observation.html#grid2op.Observation.BaseObservation.curtailment
87-
.. _curtailment_limit: ./observation.html#grid2op.Observation.BaseObservation.curtailment_limit
88-
.. _is_alarm_illegal: ./observation.html#grid2op.Observation.BaseObservation.is_alarm_illegal
89-
.. _time_since_last_alarm: ./observation.html#grid2op.Observation.BaseObservation.time_since_last_alarm
90-
.. _last_alarm: ./observation.html#grid2op.Observation.BaseObservation.last_alarm
91-
.. _attention_budget: ./observation.html#grid2op.Observation.BaseObservation.attention_budget
92-
.. _max_step: ./observation.html#grid2op.Observation.BaseObservation.max_step
93-
.. _current_step: ./observation.html#grid2op.Observation.BaseObservation.current_step
94-
.. _delta_time: ./observation.html#grid2op.Observation.BaseObservation.delta_time
95-
.. _gen_margin_up: ./observation.html#grid2op.Observation.BaseObservation.gen_margin_up
96-
.. _gen_margin_down: ./observation.html#grid2op.Observation.BaseObservation.gen_margin_down
97-
.. _curtailment_mw: ./observation.html#grid2op.Observation.BaseObservation.curtailment_mw
98-
.. _theta_or: ./observation.html#grid2op.Observation.BaseObservation.theta_or
99-
.. _theta_ex: ./observation.html#grid2op.Observation.BaseObservation.theta_ex
100-
.. _gen_theta: ./observation.html#grid2op.Observation.BaseObservation.gen_theta
101-
.. _load_theta: ./observation.html#grid2op.Observation.BaseObservation.load_theta
102-
.. _active_alert: ./observation.html#grid2op.Observation.BaseObservation.active_alert
103-
.. _time_since_last_alert: ./observation.html#grid2op.Observation.BaseObservation.time_since_last_alert
104-
.. _alert_duration: ./observation.html#grid2op.Observation.BaseObservation.alert_duration
105-
.. _total_number_of_alert: ./observation.html#grid2op.Observation.BaseObservation.total_number_of_alert
106-
.. _time_since_last_attack: ./observation.html#grid2op.Observation.BaseObservation.time_since_last_attack
107-
.. _was_alert_used_after_attack: ./observation.html#grid2op.Observation.BaseObservation.was_alert_used_after_attack
108-
.. _attack_under_alert: ./observation.html#grid2op.Observation.BaseObservation.attack_under_alert
41+
.. (c) Lilian Besson, 2011-2016, https://bitbucket.org/lbesson/web-sphinx/

0 commit comments

Comments
 (0)