eliater
A high level, end-to-end causal inference workflow
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary
Repository
A high level, end-to-end causal inference workflow
Basic Info
- Host: GitHub
- Owner: y0-causal-inference
- License: mit
- Language: Jupyter Notebook
- Default Branch: main
- Size: 2.98 MB
Statistics
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 8
- Releases: 2
Metadata Files
README.md
Eliater
A high level, end-to-end causal inference workflow.
📚 Case Studies
🚀 Installation
The most recent release can be installed from PyPI with:
shell
$ pip install eliater
The most recent code and data can be installed directly from GitHub with:
bash
$ pip install git+https://github.com/y0-causal-inference/eliater.git
👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.
👋 Attribution
⚖️ License
The code in this package is licensed under the MIT License.
🍪 Cookiecutter
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.
🛠️ For Developers
See developer instructions
The final section of the README is for if you want to get involved by making a code contribution. ### Development Installation To install in development mode, use the following: ```bash $ git clone git+https://github.com/y0-causal-inference/eliater.git $ cd eliater $ pip install -e . ``` ### 🥼 Testing After cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be run reproducibly with: ```shell $ tox ``` Additionally, these tests are automatically re-run with each commit in a [GitHub Action](https://github.com/y0-causal-inference/eliater/actions?query=workflow%3ATests). ### 📖 Building the Documentation The documentation can be built locally using the following: ```shell $ git clone git+https://github.com/y0-causal-inference/eliater.git $ cd eliater $ tox -e docs $ open docs/build/html/index.html ``` The documentation automatically installs the package as well as the `docs` extra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins like `texext` can be added there. Additionally, they need to be added to the `extensions` list in [`docs/source/conf.py`](docs/source/conf.py). ### 📦 Making a Release After installing the package in development mode and installing `tox` with `pip install tox`, the commands for making a new release are contained within the `finish` environment in `tox.ini`. Run the following from the shell: ```shell $ tox -e finish ``` This script does the following: 1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the version number in the `setup.cfg`, `src/eliater/version.py`, and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix 2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build) 3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to have a `.pypirc` file configured to avoid the need for manual input at this step 4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped. 5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can use `tox -e bumpversion -- minor` after.Owner
- Name: Why Not?
- Login: y0-causal-inference
- Kind: organization
- Repositories: 2
- Profile: https://github.com/y0-causal-inference
y0 (pronounced "why not?") is for causal inference in Python
Citation (CITATION.cff)
cff-version: 1.0.2 message: "If you use this software, please cite it as below." title: "Eliater" authors: - name: "Sara Taheri" version: 0.0.1-dev doi: url: "https://github.com/y0-causal-inference/eliater"
GitHub Events
Total
- Issue comment event: 2
Last Year
- Issue comment event: 2
Packages
- Total packages: 1
-
Total downloads:
- pypi 25 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: eliater
A high level, end-to-end causal inference workflow.
- Homepage: https://github.com/y0-causal-inference/eliater
- Documentation: https://eliater.readthedocs.io
- License: MIT
-
Latest release: 0.0.2
published about 2 years ago