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

Standard installation through pip and conda #6

Closed
cbouy opened this issue Jan 12, 2021 · 11 comments
Closed

Standard installation through pip and conda #6

cbouy opened this issue Jan 12, 2021 · 11 comments
Assignees
Labels
enhancement New feature or request

Comments

@cbouy
Copy link
Member

cbouy commented Jan 12, 2021

TL;DR: don't pip install prolif yet

ProLIF currently depends on a custom fork of MDAnalysis which is not available on the PyPI repositories. This is because ProLIF depends on features that are not yet merged in the main branch of MDAnalysis, and that will be available in one of their next release.

Until all the needed features are released on PyPI, I have to rely on this custom fork, which makes it impossible to upload ProLIF v0.3.0 and above to PyPI (see this build for more technical info).

The package that is currently installed with pip install prolif is a much older version that corresponds to this GitHub repository that I decided to deprecate as it has bugs, is untested, and could only read some MOL2 files.

Once the MDAnalysis update is on PyPI, I'll upload the releases there. For conda, I'm guessing the issue will be the same (I doubt that I can have dependencies that aren't on conda/pip) so I'll wait for this as well.

For now, stay safe and pip install git+https://github.com/chemosim-lab/ProLIF.git, or even better, refer to the installation instructions.

@cbouy cbouy added the enhancement New feature or request label Jan 12, 2021
@cbouy cbouy self-assigned this Jan 12, 2021
@lordmiss
Copy link

lordmiss commented Oct 7, 2021

I found out that MDAnaysis 2.0 was released at last August. Can you confirm if it contains the features you need and update ProLIF, please?

@cbouy
Copy link
Member Author

cbouy commented Oct 7, 2021

Hi @lordmiss,

Unfortunately no, the base features are there in v2.0.0 but the more accurate version of the code has been delayed to v2.1.0 so it will have to wait until I and the MDAnalysis code devs can find some time to finish working on the update. When this is done, I will update the installation process and upload it on Pypi.

If you really need a standard installation and you are okay with verifying the output molecule (see the 3 first code cells on this documentation), you could try to clone this repository and change the MDAnalysis requirement in the setup file here to mdanalysis==2.0.0. On Linux that can be done with the following commands:

git clone https://github.com/chemosim-lab/ProLIF.git
cd ProLIF
sed -i 's/mdanalysis.*/mdanalysis==2.0.0/' setup.cfg
pip install .

Hope this answers your question,
Cédric

@lordmiss
Copy link

Hi @cbouy,

Thank you for your detailed explanation and great work. I understood.

Stay healthy!
�Hanjo

@hadim
Copy link

hadim commented Jan 12, 2022

For the record here is the conda package: conda-forge/staged-recipes#17499 which is currently blocked by mdanalysis (require the 2.1.0 to be released first).

@IAlibay
Copy link
Contributor

IAlibay commented Jan 17, 2022

I'm likely to release MDA 2.1.0 over the coming week or so. If this needs to be in 2.1.0 may I ask for someone to push for MDAnalysis/mdanalysis#3044 to finish review? (I've completely lost track of where that PR stands, if it's close to completion then let's aim to get it merged before 2.1.0).

@cbouy
Copy link
Member Author

cbouy commented Jan 18, 2022

@IAlibay sure, from what I remember it was close to being done, maybe missing a few tests.
I've just rebased the branch from develop, I'll do my best to tackle test failures and missing coverage when that's done.

@cbouy
Copy link
Member Author

cbouy commented Mar 2, 2022

Quick update to avoid any confusion: it's now scheduled for MDAnalysis v2.2.0.

This way the MDAnalysis core developers can release 2.1.0 very soon without having to wait for me, and 2.2.0 will come out shortly after (technically as soon as I'm done working on the corresponding PR).

@hadim
Copy link

hadim commented Mar 3, 2022

Thanks for the update @cbouy.

Just ping again once ready, and I will warp up the feedstock PR.

@cbouy cbouy mentioned this issue Jun 5, 2022
7 tasks
@noahharrison64
Copy link

Hi @cbouy

Looks like v2.2.0 has just been released! Is there an ETA for the next ProLIF update?

@cbouy
Copy link
Member Author

cbouy commented Jun 6, 2022

Hi @noahharrison64, yes indeed!
I should be able to release the pip-friendly version of ProLIF this week, see PR #54 for more details on the status.

cbouy added a commit that referenced this issue Jun 7, 2022
## [1.0.0] - 2022-06-07

### Added
- Support for multiprocessing, enabled by default (Issue #46). The number of processes can
  be controlled through `n_jobs` in `fp.run` and `fp.run_from_iterable`.
- New interaction: van der Waals contact, based on the sum of vdW radii of two atoms.
- Saving/loading the fingerprint object as a pickle with `fp.to_pickle` and
  `Fingerprint.from_pickle` (Issue #40).
### Changed
- Molecule suppliers can now be indexed, reused and can return their length, instead of
  being single-use generators.
### Fixed
- ProLIF can now be installed through pip and conda (Issue #6).
- If no interaction is detected in the first frame, `to_dataframe` will not complain about
  a `KeyError` anymore (Issue #44).
- When creating a `plf.Fingerprint`, unknown interactions will no longer fail silently.
@cbouy
Copy link
Member Author

cbouy commented Jun 8, 2022

ProLIF 1.0.0 is now available on both pip and conda-forge!

@cbouy cbouy closed this as completed Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants