Skip to content

[Code scan] Clean up non-portable example notebooks and unpublished pip command #45

Description

@njzjz

This issue comes from a Codex global repository scan.

Problem

Some examples are not reproducible from a fresh checkout.

example/dftio_demo.ipynb executes Field.from_cube("xxx.cube"), but no xxx.cube fixture exists in the repository:

"f = Field.from_cube(\"xxx.cube\")"

The SIESTA notebooks contain private absolute paths and stale imports, so they fail outside the author's machine:

"struct = sisl.get_sile(\"/personal/DeepTB/dptb_Zjj/DFTIO/dftio/test/data/siesta/siesta_out/RUN.fdf\").read_geometry()\n",

"from ...data import _keys\n",

"from dptb.data import build_dataset\n",
"\n",
"dataset = build_dataset(\n",
" root=\"/personal/DeepTB/dptb_Zjj/DFTIO/dftio/test/data/test_siesta2\",\n",

The README also shows an uncommented pip install dftio command under a “coming soon” heading, which fails while the package is not published to PyPI:

dftio/README.md

Lines 42 to 46 in c9d128f

### Using pip (from PyPI - coming soon)
```bash
pip install dftio
```

Suggested fix

Add a small cube fixture or make that notebook cell non-executed, replace private paths/stale imports in SIESTA notebooks with repo-relative examples, and remove or comment out the PyPI install command until publication.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions