Skip to content

Commit d801ce6

Browse files
authored
add exported file structure (#184)
1 parent 2a55d36 commit d801ce6

File tree

1 file changed

+56
-4
lines changed

1 file changed

+56
-4
lines changed

docs/source/data_access.rst

+56-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,59 @@ In order to use this functionality you'll need to clone the mendeleev repository
8888

8989
.. code-block:: bash
9090
91-
gh clone lmmentel/mendeleev
92-
cd mendeleev
93-
poetry install
94-
poetry run inv export
91+
gh clone lmmentel/mendeleev
92+
cd mendeleev
93+
poetry install
94+
poetry run inv export
95+
96+
97+
After the command is executed you'll find the exported files in the `data` directory. The
98+
contents should look like this:
99+
100+
.. code-block:: bash
101+
102+
data
103+
├── csv
104+
│   ├── elements.csv
105+
│   ├── groups.csv
106+
│   ├── ionicradii.csv
107+
│   ├── ionizationenergies.csv
108+
│   ├── isotopedecaymodes.csv
109+
│   ├── isotopes.csv
110+
│   ├── oxidationstates.csv
111+
│   ├── phasetransitions.csv
112+
│   ├── screeningconstants.csv
113+
│   └── series.csv
114+
├── html
115+
│   ├── elements.html
116+
│   ├── groups.html
117+
│   ├── ionicradii.html
118+
│   ├── ionizationenergies.html
119+
│   ├── isotopedecaymodes.html
120+
│   ├── isotopes.html
121+
│   ├── oxidationstates.html
122+
│   ├── phasetransitions.html
123+
│   ├── screeningconstants.html
124+
│   └── series.html
125+
├── json
126+
│   ├── elements.json
127+
│   ├── groups.json
128+
│   ├── ionicradii.json
129+
│   ├── ionizationenergies.json
130+
│   ├── isotopedecaymodes.json
131+
│   ├── isotopes.json
132+
│   ├── oxidationstates.json
133+
│   ├── phasetransitions.json
134+
│   ├── screeningconstants.json
135+
│   └── series.json
136+
└── markdown
137+
├── elements.markdown
138+
├── groups.markdown
139+
├── ionicradii.markdown
140+
├── ionizationenergies.markdown
141+
├── isotopedecaymodes.markdown
142+
├── isotopes.markdown
143+
├── oxidationstates.markdown
144+
├── phasetransitions.markdown
145+
├── screeningconstants.markdown
146+
└── series.markdown

0 commit comments

Comments
 (0)