pepflow 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

{pepflow-0.1.4.dist-info → pepflow-0.1.5.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: pepflow
-Version: 0.1.4
+Version: 0.1.5
 Summary: PEPFlow: A framework for Performance Estimation Problem (PEP) Workflow
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: attrs>=25.3.0
@@ -37,6 +37,7 @@ uv sync; source .venv/bin/activate;
 
 In windows, use `.venv\Scripts\activate` instead.
 
+### Lint & Testing
 We use `ruff` to do the format and lint and `isort` to do the import ordering.
 
 ```bash
@@ -45,12 +46,30 @@ ruff check .;
 isort .;
 ```
 
-### Testing
-
 We use `pytest` framework to do the test. To run all unit tests, run the following command:
 
-```python
+```bash
 pytest -s -vv pepflow
 ```
 
+We have a convenient script to above
+```bash
+scripts/check.sh [format|lint|typecheck|test]
+```
+See the script for the options.
+
+### Build doc website
+
+Install the required library (one-time) and `pandoc` in order to build ipynb.
+```bash
+pip install -r docs/requirements.txt
+```
+
+To build the website, run
+```bash
+scripts/build_doc.sh [--serve-only]
+```
+The argument `--serve-only` is optional for hosting the website locally.
+
+
 

pepflow-0.1.5.dist-info/RECORD

@@ -0,0 +1,28 @@
+pepflow/__init__.py,sha256=uF-c0NyR8z9sASDj8nvd3Vz1a4gFm7ZcdH-SyR3h0bs,2250
+pepflow/constants.py,sha256=t29CDRE8kw773zgKS0ZZCYGegwagaDDdLfpSaeDpK14,871
+pepflow/constraint.py,sha256=aFcdOprdBc5peT7oL5IXlfnvnGw1qadPLtKsy1Cbrac,3555
+pepflow/constraint_test.py,sha256=6MF__r67NooqOVXHtkeOVcg_ebycMF_xI9OpFDFiV4c,2676
+pepflow/e2e_test.py,sha256=jo4pWoXq9XJFmdfvJeSUdCIlmdmk_Qp2QCjOLelPqMY,3701
+pepflow/expression_manager.py,sha256=AD2AHQGvmjRltsKgXiG9QV5oUZFpQsTgd-dky5uNRi0,17875
+pepflow/expression_manager_test.py,sha256=ZzwZGc-rP5iey8aXMakeq_0PbMW6Tf7DmMxzSeJe2Bg,5493
+pepflow/function.py,sha256=19TocYEjO5Wn24IpJYmzP_UTwyR_Pg3uzE_-zluC3CM,22867
+pepflow/function_test.py,sha256=RBBm_Z6SKD3Vd03eUAO4XPONyXXueT8w1eiRLeA4IuI,8263
+pepflow/interactive_constraint.py,sha256=mB3AQt21kIdRR0yqtvUksoELSLSoTDkMeu07ThKPerE,12757
+pepflow/parameter.py,sha256=yknpFWzj91gfDKjRVgRDMG57mKeKE1Qqcnm4i2tZzok,6246
+pepflow/parameter_test.py,sha256=fLmKvoLKu_-GULDXcpXmoAZA17mx0m9Zm3twfXQUin0,4199
+pepflow/pep.py,sha256=hCB2jXjLCU_5jgykZD6jwch4fDvdvy-aX4jmQpF6jWs,16222
+pepflow/pep_context.py,sha256=Y6JD28TAf39SB8G_FuqQnd4HVgit1viGIOTs4lzdzgg,9184
+pepflow/pep_context_test.py,sha256=B12M4eni0MVL_30v6yAf4ognWc1YxNTaR50_F01iGnI,4052
+pepflow/pep_test.py,sha256=-diI87sk10417oBnPRgWxY6XhiKOPoK7m5-MTkmlTcw,2788
+pepflow/point.py,sha256=pv0yr4oQsfBlzKLPMWPeR6WfdF4W-l_AaR5GFg_Me7o,12570
+pepflow/point_test.py,sha256=Rm-uOvB9GjIwH3XGnWr5UfTRqzlZRb8u-esV5b-bgtY,5667
+pepflow/scalar.py,sha256=oZjsfXZEhofxszk21pmcvNQOh8_N_6G_PfH3STbugH4,18315
+pepflow/scalar_test.py,sha256=fYtKfe-nO4GhAIIrZrW0Lx_fbFHqIxsKbPPA-G5udnE,7082
+pepflow/solver.py,sha256=ZThfiaSDru-gHxn21PC8T71ePzTykAhSRCteOaOBbcQ,11381
+pepflow/solver_test.py,sha256=NuH6yF-NTItkv3x0U40HFJ7xbSNi407qg4QGlVmXqHU,4063
+pepflow/utils.py,sha256=-Uu0TlJyqpGNT4DmdLtvXWNFPHn06zKHF7Jr1NHz7LQ,2743
+pepflow-0.1.5.dist-info/licenses/LICENSE,sha256=na5oVXAps-5f1hLGG4SYnwFdavQeXgYUeN-E3MxOA_s,11361
+pepflow-0.1.5.dist-info/METADATA,sha256=ULyUflh7uT2lqFhobLqMqWxU4uPwfKoBWPa5u7Ojmvc,1867
+pepflow-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pepflow-0.1.5.dist-info/top_level.txt,sha256=0YEPCZQQa6yIAIwMumzDg4pj7AME8aXu2sXkuq8xM6M,8
+pepflow-0.1.5.dist-info/RECORD,,

pepflow-0.1.4.dist-info/RECORD

@@ -1,24 +0,0 @@
-pepflow/__init__.py,sha256=tLnOlZ1y_mIodRl5Fr5HMLPP5M7h_ad76s4in5OgiHE,1930
-pepflow/constants.py,sha256=t29CDRE8kw773zgKS0ZZCYGegwagaDDdLfpSaeDpK14,871
-pepflow/constraint.py,sha256=n-01dcQplvsXB7V4fceJBImbwSr-Wa9k9tE7ZcVmi3o,1153
-pepflow/e2e_test.py,sha256=9UfWefn5kq9Jn7L7tMRPtnkUMaac3uJIbU8-qcUYvd0,1080
-pepflow/expression_manager.py,sha256=64FbdMjcUrIqtbFZyJoxoDZ42j1bl1CeGxhJnKcGTD8,5222
-pepflow/function.py,sha256=Ghgm2yyKsq7WSQfTufub5h8kD7j7ouwYfLd2hdRBw-w,14212
-pepflow/function_test.py,sha256=dm4qcEiB8sshqRQ4zphQlJP-lE6IcVrwf1CDTwUmz9M,6903
-pepflow/interactive_constraint.py,sha256=HMwAo80tJyCKwWKryxNGk1LAh-qlnQk5OeULLwKZUOQ,9826
-pepflow/pep.py,sha256=fLjEc3dtpDKiVXV2T5vQGJKRDYim6piuNQZHsmxiKc4,6082
-pepflow/pep_context.py,sha256=9an5fwdjqft7P_7MkRQ1TWYI-5_qw3VSD9qLLQGdX6Y,4719
-pepflow/pep_context_test.py,sha256=FqMsIznBcM4NmBU9mb1tGh4vUwmuJ-MWa3GMA_pg6Ik,3252
-pepflow/pep_test.py,sha256=aWwP3CqXNJzQUhJqC5sNcsM83i_asJaZewpGNqC1G7M,2504
-pepflow/point.py,sha256=vSKCuivJL3zyUCnV48rfM5XpAGsVbdQ8YWdO3fKrViI,8514
-pepflow/point_test.py,sha256=ojWJ-mOS2XJsTKuNhlMGBmOzPYSrknaTGIJi6mXLoEk,10708
-pepflow/scalar.py,sha256=8E-D5pgZCDpyEX13VwrFARo87v-HWAUs4gAD_-Ty_g8,9653
-pepflow/scalar_test.py,sha256=T2-KGjWUsZGWZII64DEmUiVnu8o4Kr9Mi0YCgSUvYVc,8386
-pepflow/solver.py,sha256=WzeN_IWNBs9IpE212jenhYMWFuuwH890h0vaFmJRM6I,4312
-pepflow/solver_test.py,sha256=-aCEe-oQ26xJUWR64b-CIIfFOK_pNJnMlOly2bagk68,2457
-pepflow/utils.py,sha256=Xd-DwtUoUSMw_i6xjYsOxsHmn8l3ZbYCyptXEBfoyZk,1718
-pepflow-0.1.4.dist-info/licenses/LICENSE,sha256=na5oVXAps-5f1hLGG4SYnwFdavQeXgYUeN-E3MxOA_s,11361
-pepflow-0.1.4.dist-info/METADATA,sha256=eMSRF3dk0eWgwicdFSsnJVxjsTcS9rG5Jp-OF9orDO4,1434
-pepflow-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pepflow-0.1.4.dist-info/top_level.txt,sha256=0YEPCZQQa6yIAIwMumzDg4pj7AME8aXu2sXkuq8xM6M,8
-pepflow-0.1.4.dist-info/RECORD,,