Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pip install alpineer doesn't work #52

Open
AnanyaBhalla opened this issue Feb 3, 2025 · 1 comment
Open

pip install alpineer doesn't work #52

AnanyaBhalla opened this issue Feb 3, 2025 · 1 comment
Labels
bug Something isn't working

Comments

@AnanyaBhalla
Copy link

AnanyaBhalla commented Feb 3, 2025

Appreciate some feedback on the below:

  1. Is it not possible to pip install alpineer and import alpineer for usage?
  2. Why is poetry and git cloning the repo needed?
  3. Also, there is no usage documentation on https://pypi.org/project/alpineer/
@AnanyaBhalla AnanyaBhalla added the bug Something isn't working label Feb 3, 2025
@srivarra
Copy link
Contributor

srivarra commented Feb 4, 2025

@AnanyaBhalla

  1. Is it not possible to pip install alpineer and import alpineer for usage?

You can install alpineer with pip install alpineer, as it is available on PyPI. Make sure you're using Python 3.10 or higher.

  1. Why is poetry and git cloning the repo needed?

That's just dev documentation since it comes with angelolab/ark-analysis and angelolab/toffy and isn't intended to be used as a standalone package.

  1. Also, there is no usage documentation on https://pypi.org/project/alpineer/

There are no readthedocs or usage documentation, but there are docstrings for many of the functions. You can use the functions by importing them directly with respect to their submodule as below:

from alpineer.misc_utils import verify_same_elements

verify_same_elements(...)

May I ask what did you planned on using alpineer for?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants