Skip to content

Commit 0f10646

Browse files
agroeneragroener
committed
Yet even more changes to cosmosim docs
1 parent 72fd4bd commit 0f10646

File tree

1 file changed

+130
-58
lines changed

1 file changed

+130
-58
lines changed

‎docs/cosmosim/cosmosim.rst‎

Lines changed: 130 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ few examples of functions available to the user for these purposes.
8484
>>> CS.check_all_jobs()
8585
JobID Phase
8686
--------------- ---------
87-
361298054830707 COMPLETED
87+
359748449665484 COMPLETED
8888
>>> CS.delete_job(jobid='359748449665484')
8989
Deleted job: 359748449665484
9090
>>> CS.check_all_jobs()
@@ -186,73 +186,145 @@ Exploring Database Schema
186186
A database exploration tool is available to help the user navigate
187187
the structure of any simulation database in the CosmoSim database.
188188

189+
.. code-block:: python
189190
190-
Legend
191+
>>> CS.explore_db()
192+
Must first specify a database.
193+
Projects Project Items Information
194+
------------------------ ------------- --------------------------------------------------------------------------------------
195+
@ Bolshoi @ tables
196+
id: 2
197+
description: The Bolshoi Database.
198+
------------------------ ------------- --------------------------------------------------------------------------------------
199+
@ BolshoiP @ tables
200+
id: 119
201+
description: Bolshoi Planck simulation
202+
------------------------ ------------- --------------------------------------------------------------------------------------
203+
@ Clues3_LGDM @ tables
204+
id: 134
205+
description: CLUES simulation, B64, 186592, WMAP3, Local Group resimulation, 4096, Dark Matter only
206+
------------------------ ------------- --------------------------------------------------------------------------------------
207+
@ Clues3_LGGas @ tables
208+
id: 124
209+
description: CLUES simulation, B64, 186592, WMAP3, Local Group resimulation, 4096, Gas+SFR
210+
------------------------ ------------- --------------------------------------------------------------------------------------
211+
@ MDPL @ tables
212+
id: 114
213+
description: The MDR1-Planck simulation.
214+
------------------------ ------------- --------------------------------------------------------------------------------------
215+
@ MDR1 @ tables
216+
id: 7
217+
description: The MultiDark Run 1 Simulation.
218+
------------------------ ------------- --------------------------------------------------------------------------------------
219+
@ cosmosim_user_username @ tables
220+
id: userdb
221+
description: Your personal database
222+
------------------------ ------------- --------------------------------------------------------------------------------------
191223
192-
'@' : type == dict
224+
.. code-block:: python
193225
194-
'$' : type != dict
226+
>>> CS.explore_db(db='MDPL')
227+
Projects Project Items Tables
228+
----------- ------------- -------------
229+
--> @ MDPL: --> @ tables: @ FOF
230+
id @ FOF5
231+
description @ FOF4
232+
@ FOF3
233+
@ FOF2
234+
@ FOF1
235+
@ BDMW
236+
@ Redshifts
237+
@ LinkLength
238+
@ AvailHalos
239+
@ Particles88
195240
196241
.. code-block:: python
197242
198-
>>> CS.explore_db(db='MDPL')
199-
########
200-
# MDPL #
201-
########
202-
@ tables
203-
--> FOF5
204-
--> FOF4
205-
--> FOF3
206-
--> FOF2
207-
--> FOF1
208-
--> Particles88
209-
--> FOF
210-
--> LinkLength
211-
--> BDMW
212-
--> AvailHalos
213-
--> Redshifts
214-
--> Particles42
215-
$ id
216-
--> 114
217-
$ description
218-
--> The MDR1-Planck simulation.
219-
243+
>>> CS.explore_db(db='MDPL',table='FOF')
244+
Projects Project Items Tables Table Items Table Info Columns
245+
----------- ------------- ------------- ------------ ---------- --------
246+
--> @ MDPL: --> @ tables: --> @ FOF: id: 934 y
247+
id @ FOF5 @ columns x
248+
description @ FOF4 description: z
249+
@ FOF3 ix
250+
@ FOF2 iz
251+
@ FOF1 vx
252+
@ BDMW vy
253+
@ Redshifts vz
254+
@ LinkLength iy
255+
@ AvailHalos np
256+
@ Particles88 disp
257+
size
258+
spin
259+
mass
260+
axis1
261+
axis2
262+
axis3
263+
fofId
264+
phkey
265+
delta
266+
level
267+
angMom
268+
disp_v
269+
axis1_z
270+
axis1_x
271+
axis1_y
272+
axis3_x
273+
axis3_y
274+
axis3_z
275+
axis2_y
276+
axis2_x
277+
NInFile
278+
axis2_z
279+
snapnum
280+
angMom_x
281+
angMom_y
282+
angMom_z
283+
220284
.. code-block:: python
221285
222-
>>> CS.explore_db(db='MDPL',table='AvailHalos')
223-
########
224-
# MDPL #
225-
########
226-
@ tables
227-
@ AvailHalos
228-
$ id
229-
--> 932
230-
@ columns
231-
--> FOF5
232-
--> FOF4
233-
--> FOF3
234-
--> FOF2
235-
--> FOF1
236-
--> redshift
237-
--> BDM
238-
--> FOF
239-
--> snapnum
240-
$ description
241-
-->
286+
>>> CS.explore_db(db='MDPL',table='FOF',col='fofId')
287+
Projects Project Items Tables Table Items Columns
288+
----------- ------------- ------------- -------------- ------------
289+
--> @ MDPL: --> @ tables: --> @ FOF: --> @ columns: --> @ fofId:
290+
id @ FOF5 id @ disp
291+
description @ FOF4 description @ axis1_z
292+
@ FOF3 @ axis1_x
293+
@ FOF2 @ axis1_y
294+
@ FOF1 @ ix
295+
@ BDMW @ iz
296+
@ Redshifts @ axis3_x
297+
@ LinkLength @ axis3_y
298+
@ AvailHalos @ axis3_z
299+
@ Particles88 @ vx
300+
@ vy
301+
@ vz
302+
@ axis2_y
303+
@ axis2_x
304+
@ size
305+
@ axis1
306+
@ axis2
307+
@ axis3
308+
@ iy
309+
@ angMom
310+
@ NInFile
311+
@ np
312+
@ axis2_z
313+
@ disp_v
314+
@ phkey
315+
@ delta
316+
@ snapnum
317+
@ spin
318+
@ level
319+
@ angMom_x
320+
@ angMom_y
321+
@ angMom_z
322+
@ mass
323+
@ y
324+
@ x
325+
@ z
242326
243-
.. code-block:: python
244327
245-
>>> CS.explore_db(db='MDPL',table='AvailHalos',col='redshift')
246-
########
247-
# MDPL #
248-
########
249-
@ tables
250-
@ AvailHalos
251-
@ columns
252-
@ redshift
253-
--> id:21613
254-
--> description:
255-
256328
Downloading data
257329
================
258330

0 commit comments

Comments
 (0)