FAIRmat-NFDI / nomad-perovskite-solar-cells-database / 21151250273
30%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 3328
Run time 8min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 30.295% (-0.4%) from 30.664%
21151250273

push

github

web-flow 
Revamp docs: ranames the jupyter notebooks and adds them to the docs  (#120)

* Draft changes

* Standardize notebook naming: rename underscores to hyphens

- Renamed diversity_analysis.ipynb → diversity-analysis.ipynb
- Renamed ml_distribution_shift_case_study.ipynb → ml-distribution-shift-case-study.ipynb
- Renamed perovskite_paperbot_plot.ipynb → perovskite-paperbot-plot.ipynb
- Updated .gitignore to exclude notebook copies and parquet data files
- Moved notebooks from perovskite_database to perla directory

* Clean notebooks: remove author names, fix typos

- Removed author attribution from 6 notebook headers (kept NOMAD branding)
- Fixed typo: "Perovksite" → "Perovskite" in query-perovskite-database.ipynb
- All notebooks now have clean, descriptive headers without author names
- Notebooks affected: query-perovskite-database, performance-evolution, crabnet-perovskite-bandgap-prediction (perla), build-perovskite-structure-from-ion-entry, query-ion-database-api, query-perovskite-composition (ions_database)

* Configure mkdocs-jupyter plugin with enhanced Material theme

- Set mkdocs-jupyter to use pre-executed outputs (execute: false)
- Enable include_source for code visibility
- Enable Material theme features: navigation tabs, sections, expand, indexes, path, footer, top
- Enable toc.follow and content.code.copy for better user experience
- All settings optimized for jupyter-book-style documentation

* Add notebooks to navigation in learning order with tutorial index

- Created comprehensive tutorial/index.md with notebook categorization
- Added all 13 notebooks to Tutorial > Notebooks section in logical order:
  * Basic queries (query databases, compositions)
  * Structure building (build from ions)
  * Data analysis (architecture, bandgap, performance, diversity evolution)
  * Specialized tools (perovscribe, paperbot)
  * Machine learning (CrabNet, distribution shift)
- Notebooks organized by pedagogical progression
- Tutorial section now include... (continued)

159611 of 526857 relevant lines covered (30.29%)

0.3 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
2
70.83
 0.0% .venv/lib/python3.12/site-packages/openpyxl/xml/__init__.py
2
17.04
 -0.12% .venv/lib/python3.12/site-packages/PIL/Image.py
2
14.21
 -0.25% .venv/lib/python3.12/site-packages/tabulate/__init__.py
47
55.12
 0.0% .venv/lib/python3.12/site-packages/pyarrow/compute.py
56
19.74
 -1.55% .venv/lib/python3.12/site-packages/pyarrow/__init__.py
452
14.59
 -0.03% .venv/lib/python3.12/site-packages/pyasn1/codec/ber/decoder.py
Jobs
ID Job ID Ran Files Coverage
1 21151250273.1 3328
30.29
 GitHub Action Run
Source Files on build 21151250273