lifejacket 0.2.0__tar.gz → 1.0.0__tar.gz

lifejacket-1.0.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: lifejacket
+Version: 1.0.0
+Summary: Consistent standard errors for longitudinal data collected under pooling online decision policies.
+Author-email: Nowell Closser <nowellclosser@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: jax>=0.4.0
+Requires-Dist: jaxlib>=0.4.0
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: plotext>=5.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: flake8>=4.0; extra == "dev"
+
+```python
+  _ _  __     _            _        _
+ | (_)/ _|   (_)          | |      | |
+ | |_| |_ ___ _  __ _  ___| | _____| |_
+ | | |  _/ _ \ |/ _` |/ __| |/ / _ \ __|
+ | | | ||  __/ | (_| | (__|   <  __/ |_
+ |_|_|_| \___| |\__,_|\___|_|\_\___|\__|
+            _/ |
+           |__/
+```
+
+Save your standard errors from pooling in online decision-making algorithms.
+
+## Setup (if not using conda)
+### Create and activate a virtual environment
+- `python3 -m venv .venv; source /.venv/bin/activate`
+
+### Adding a package
+- Add to `requirements.txt` with a specific version or no version if you want the latest stable
+- Run `pip freeze > requirements.txt` to lock the versions of your package and all its subpackages
+
+## Running the code
+- `export PYTHONPATH to the absolute path of this repository on your computer
+- `./run_local_synthetic.sh`, which outputs to `simulated_data/` by default. See all the possible flags to be toggled in the script code.
+
+## Linting/Formatting
+
+## Testing
+python -m pytest
+python -m pytest tests/unit_tests
+python -m pytest tests/integration_tests
+
+
+
+## TODO
+1. Add precommit hooks (pip freeze, linting, formatting)
+

lifejacket-1.0.0/README.md

@@ -0,0 +1,37 @@
+```python
+  _ _  __     _            _        _
+ | (_)/ _|   (_)          | |      | |
+ | |_| |_ ___ _  __ _  ___| | _____| |_
+ | | |  _/ _ \ |/ _` |/ __| |/ / _ \ __|
+ | | | ||  __/ | (_| | (__|   <  __/ |_
+ |_|_|_| \___| |\__,_|\___|_|\_\___|\__|
+            _/ |
+           |__/
+```
+
+Save your standard errors from pooling in online decision-making algorithms.
+
+## Setup (if not using conda)
+### Create and activate a virtual environment
+- `python3 -m venv .venv; source /.venv/bin/activate`
+
+### Adding a package
+- Add to `requirements.txt` with a specific version or no version if you want the latest stable
+- Run `pip freeze > requirements.txt` to lock the versions of your package and all its subpackages
+
+## Running the code
+- `export PYTHONPATH to the absolute path of this repository on your computer
+- `./run_local_synthetic.sh`, which outputs to `simulated_data/` by default. See all the possible flags to be toggled in the script code.
+
+## Linting/Formatting
+
+## Testing
+python -m pytest
+python -m pytest tests/unit_tests
+python -m pytest tests/integration_tests
+
+
+
+## TODO
+1. Add precommit hooks (pip freeze, linting, formatting)
+