Skip to content

Commit

Permalink
Added readme notes, Changed dependencies (#15)
Browse files Browse the repository at this point in the history
* Bugfix: Fix check of src change

* Added install notes, Updated dependencies to numpy2.0
  • Loading branch information
charnley authored Nov 5, 2024
1 parent db02054 commit 1243f11
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 11 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ all: env
env:
${mamba} env create -f ./environment_dev.yaml -p ./env --quiet
${python} -m pre_commit install
${python} -m pip install -e .
# ${python} -m pip install -e .

./.git/hooks/pre-commit:
${python} -m pre_commit install
Expand Down Expand Up @@ -88,7 +88,7 @@ gh-release:
--generate-notes

gh-has-src-changed:
git diff HEAD src | grep -q "+"
git diff HEAD^ HEAD src | grep -q "+"

gh-cancel:
gh run cancel $${GH_RUN_ID}
Expand Down
11 changes: 8 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,13 @@ You need a fortran compiler and math library. Default is `gfortran` and `openbla
sudo apt install libopenblas-dev gcc
You can install it via PyPi

A proper pip-package is on the way, for now
.. code-block:: bash
pip install qmllib
or directly from github

.. code-block:: bash
Expand All @@ -51,11 +56,11 @@ or if you want a specific feature branch
How to contribute
=================

Know a issue and want to get started developing?
Know a issue and want to get started developing? Fork it, clone it, make it , test it.

.. code-block:: bash
git clone repo.url qmllib.git
git clone your_repo qmllib.git
cd qmllib.git
make # setup env
make compile # compile
Expand Down
3 changes: 3 additions & 0 deletions _compile.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ def find_mkl():
def find_env() -> dict[str, str]:
"""Find compiler flags"""

# TODO Check if FCC is there, not not raise Error
# TODO Check if lapack / blas is there, if not raise Error

# TODO Find ifort flags, choose from FCC
# TODO Find math lib
# TODO Find os
Expand Down
3 changes: 1 addition & 2 deletions environment_dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ dependencies:
- pip:
- jupytext
- monkeytype
- numpy<2.0.0
- numpy
- pandas
- pandas
- pip
- pre-commit
- pyarrow
- pytest
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[build-system]
requires = ["setuptools", "numpy<2.0.0", "meson", "ninja"]
requires = ["setuptools", "numpy", "meson", "ninja"]
build-backend = "setuptools.build_meta"

[project]
name = "qmllib"
dynamic = ["version"]
authors = []
requires-python = ">=3.8"
requires-python = ">=3.9"
readme="README.rst"
description="Python/Fortran toolkit for representation of molecules and solids for machine learning of properties of molecules and solids."
classifiers = [
Expand All @@ -19,7 +19,7 @@ classifiers = [
"Topic :: Scientific/Engineering :: Chemistry",
]
keywords = ["qml", "quantum chemistry", "machine learning"]
dependencies=["numpy<2.0.0", "scipy"]
dependencies=["numpy", "scipy"]

[project.urls]
Homepage = "https://qmlcode.org"
Expand Down
2 changes: 1 addition & 1 deletion src/qmllib/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.0.4"
__version__ = "1.0.4" #

0 comments on commit 1243f11

Please sign in to comment.