Publish NapistuDataStore: .store

README.md

@@ -0,0 +1,82 @@
+---
+tags: ['napistu', 'biological-networks', 'graph-neural-networks', 'napistu-data-store']
+library_name: napistu-torch
+license: mit
+---
+
+# NapistuDataStore Dataset
+
+This dataset contains a complete NapistuDataStore with all artifacts published as a read-only store.
+
+## Store Contents
+
+- **NapistuData artifacts**: 2
+- **VertexTensor artifacts**: 1
+- **pandas DataFrame artifacts**: 5
+- **Total artifacts**: 8
+
+## Artifacts
+
+### NapistuData
+- `relation_prediction`
+- `edge_prediction`
+
+### VertexTensors
+- `comprehensive_pathway_memberships`
+
+### pandas DataFrames
+- `edge_strata_by_node_species_type`
+- `edge_strata_by_edge_sbo_terms`
+- `species_identifiers`
+- `name_to_sid_map`
+- `edge_strata_by_node_type`
+
+## Usage
+
+### Load from HuggingFace Hub
+
+```python
+from huggingface_hub import hf_hub_download
+from napistu_torch.napistu_data_store import NapistuDataStore
+import tempfile
+import shutil
+
+# Download registry.json and create a temporary store directory
+with tempfile.TemporaryDirectory() as temp_dir:
+    # Download registry.json
+    registry_path = hf_hub_download(
+        repo_id="username/repo-name",
+        filename="registry.json",
+        repo_type="dataset",
+        local_dir=temp_dir
+    )
+    
+    # Create store from downloaded registry
+    store = NapistuDataStore(temp_dir)
+    
+    # Use the store (read-only)
+    napistu_data = store.load_napistu_data("edge_prediction")
+```
+
+## Note
+
+This is a read-only store. The `sbml_dfs_path` and `napistu_graph_path` are set to None,
+so you cannot create new artifacts that require the raw SBML_dfs or NapistuGraph files.
+You can still load and use all existing artifacts.
+
+## Citation
+
+If you use this dataset, please cite:
+
+```bibtex
+@software{napistu_torch,
+  title = {Napistu-Torch: Graph Neural Networks for Biological Pathway Analysis},
+  author = {Hackett, Sean R.},
+  url = {https://github.com/napistu/Napistu-Torch},
+  year = {2025}
+}
+```
+
+## License
+
+MIT License - See [LICENSE](https://github.com/napistu/Napistu-Torch/blob/main/LICENSE) for details.