Skip to content

florence-bockting/elicito

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

412 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

elicito: A Python package for expert prior elicitation

A Python package for learning prior distributions based on expert knowledge

Key info : DOI Docs Main branch: supported Python versions Licence

PyPI : PyPI PyPI install

Conda : Conda Conda platforms Conda install

Tests : CI Coverage

Other info : Last Commit Contributors

Status

  • development: the project is actively being worked on

Full documentation can be found at: elicito.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.

Installation

As a library

If you want to use elicito as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below.

The (non-locked) version of elicito can be installed with conda for macOS and Linux and with pip for Windows, macOS and Linux.

=== "conda"

```sh
# only for macOS and Linux
conda install conda-forge::elicito
```

=== "pip"

```sh
# for macOS, Linux, and Windows
pip install elicito
```

Additional dependencies can be installed using

=== "conda"

If you are installing with conda, we recommend
installing the extras by hand because there is no stable
solution yet (see [conda issue #7502](https://github.com/conda/conda/issues/7502))

=== "pip"

```sh
# To add all optional dependencies
pip install 'elicito[full]'

# To add plotting dependencies
pip install 'elicito[plots]'

# To add scipy dependency
pip install 'elicito[scipy]'

# To add pandas dependency
pip install 'elicito[pandas]'
```

For developers

For development, we rely on uv for all our dependency management. To get started, you will need to make sure that uv is installed (instructions here (we found that the self-managed install was best, particularly for upgrading uv later).

For all of our work, we use our Makefile. You can read the instructions out and run the commands by hand if you wish, but we generally discourage this because it can be error prone. In order to create your environment, run make virtual-environment.

If there are any issues, the messages from the Makefile should guide you through. If not, please raise an issue in the issue tracker.

For the rest of our developer docs, please see [development][development].

Older versions

  • v0.5.2: DOI
  • v0.3.1: DOI

Original template

This project was generated from this template: copier core python repository. copier is used to manage and distribute this template.

About

A python package for learning prior distributions based on expert knowledge

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors