11# PySATL Core
22
3- [ status-shield ] : https://img.shields.io/github/actions/workflow/status/ PySATL/pysatl-core/ci.yml?branch=main&event=push&style=for-the-badge&label=CI
4- [ status-url ] : https://github.com/PySATL/pysatl-core/actions/workflows/ci.yml
3+ [ status-shield ] : https://github.com/ PySATL/pysatl-core/actions/workflows/ ci.yml/badge.svg ?branch=main&event=push
4+ [ status-url ] : https://github.com/PySATL/pysatl-core/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush
55[ license-shield ] : https://img.shields.io/github/license/PySATL/pysatl-core.svg?style=for-the-badge&color=blue
66[ license-url ] : LICENSE
77
@@ -14,8 +14,8 @@ The library is designed as a **foundational kernel** rather than a ready-to-use
1414
1515> ** Project status**
1616> PySATL Core is currently in ** early alpha** .
17- > It is ** not published** to package managers such as ` pip ` yet.
18- > To experiment with the library, clone the repository and work with it locally .
17+ > It is not published to PyPI yet. After the first alpha release, the package
18+ > will be installable with ` pip install pysatl-core ` .
1919
2020---
2121
@@ -42,33 +42,41 @@ The library is designed as a **foundational kernel** rather than a ready-to-use
4242- Python ** 3.12+** (the project relies on ** PEP 695** syntax)
4343- NumPy ** 2.x**
4444- SciPy ** 1.13+**
45- - A C toolchain for compiling the UNURAN bindings :
45+ - A C toolchain when building from source or from an sdist :
4646 - ** Linux/macOS:** GCC (or Clang) plus standard build utilities.
4747 - ** Windows:** Microsoft Visual C++ Build Tools (MSVC) from Visual Studio or the standalone Build Tools installer.
4848- Poetry (recommended for development)
4949
5050---
5151
52- ## Installation (from source)
52+ ## Installation
53+
54+ After the first PyPI release:
55+
56+ ``` bash
57+ pip install pysatl-core
58+ ```
59+
60+ Until then, install from source.
5361
5462Clone the repository:
5563
5664``` bash
5765git clone https://github.com/PySATL/pysatl-core.git
5866cd pysatl-core
59- git submodule update --init --remote -- recursive
67+ git submodule update --init --recursive
6068```
6169
62- ### Using Poetry (recommended)
70+ ### Development install
6371
6472``` bash
65- poetry install --with docs
73+ poetry install --with dev, docs
6674```
6775
68- ### Using pip (editable install)
76+ ### Editable runtime install
6977
7078``` bash
71- pip install -e " .[docs] "
79+ pip install -e .
7280```
7381
7482---
@@ -152,6 +160,16 @@ poetry run pytest
152160poetry run pre-commit run --all-files
153161```
154162
163+ ### Package sanity check
164+
165+ ``` bash
166+ poetry run python -m build
167+ poetry run twine check dist/*
168+ ```
169+
170+ These commands build the local distribution artifacts and validate their metadata.
171+ They do not publish anything.
172+
155173---
156174
157175## 🗺 Roadmap
0 commit comments