ndfes


Namendfes JSON
Version 3.5.1 PyPI version JSON
download
home_pageNone
SummaryCompanion library to the ndfes C++ program for analyzing umbrella sampling
upload_time2025-07-16 19:28:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords ndfes
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            INSTALLATION
------------

The configuration is performed with ``cmake``. You will need ``cmake``
(version 3.12 or later installed). The installation of the python
components is performed with ``pip``.

To install ``cmake`` and update your version of ``pip``, you can run::

   USERBASE=$(python3 -m site --user-base)
   USERSITE=$(python3 -m site --user-site)
   export PATH="${USERBASE}/bin:${PATH}"
   export PYTHONPATH="${USERSITE}:${PYTHONPATH}"
   python3 -m pip install pip --upgrade --user
   python3 -m pip install cmake --upgrade --user

You should consider adding the above export commands to your
``${HOME}/.bashrc`` and then ``source ~/.bashrc``.

If, for whatever reason, ``pip`` is unavailable on your system, you
can install it using the directions here:
https://pip.pypa.io/en/stable/installation/

To install ndfes::

   cd build
   bash ./run_cmake.sh
   make install VERBOSE=1 -j4
   cd ../local
   export PATH="${PWD}/bin:${PATH}"
   export PYTHONPATH="${PWD}/lib/python3.XX/site-packages:${PYTHONPATH}"

where ``python3.XX`` should be replaced by the appropriate python version.

ndfes has dependencies on ``blas/lapack`` and ``nlopt``.
The ``cmake`` configuration will check if these libraries are available.
If they are not available, it will automatically download them from
github and install them.

The ``blas/lapack`` libraries are installed from the openblas package.
   https://github.com/OpenMathLib/OpenBLAS
The ``nlopt`` software is used to perform nonlinear optimizations.
   https://github.com/stevengj/nlopt

These libraries could also be installed globally using your system's
package manager. For example, on Fedora, you could install them with::

   sudo dnf install NLopt-devel openblas

See the contents of ``build/run_cmake.sh`` to see how you can adjust
the compilers, compiler flags, python interpreter, and installation
directory.
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ndfes",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "ndfes",
    "author": null,
    "author_email": "\"Timothy J. Giese\" <TimothyJGiese@gmail.com>",
    "download_url": null,
    "platform": null,
    "description": "INSTALLATION\n------------\n\nThe configuration is performed with ``cmake``. You will need ``cmake``\n(version 3.12 or later installed). The installation of the python\ncomponents is performed with ``pip``.\n\nTo install ``cmake`` and update your version of ``pip``, you can run::\n\n   USERBASE=$(python3 -m site --user-base)\n   USERSITE=$(python3 -m site --user-site)\n   export PATH=\"${USERBASE}/bin:${PATH}\"\n   export PYTHONPATH=\"${USERSITE}:${PYTHONPATH}\"\n   python3 -m pip install pip --upgrade --user\n   python3 -m pip install cmake --upgrade --user\n\nYou should consider adding the above export commands to your\n``${HOME}/.bashrc`` and then ``source ~/.bashrc``.\n\nIf, for whatever reason, ``pip`` is unavailable on your system, you\ncan install it using the directions here:\nhttps://pip.pypa.io/en/stable/installation/\n\nTo install ndfes::\n\n   cd build\n   bash ./run_cmake.sh\n   make install VERBOSE=1 -j4\n   cd ../local\n   export PATH=\"${PWD}/bin:${PATH}\"\n   export PYTHONPATH=\"${PWD}/lib/python3.XX/site-packages:${PYTHONPATH}\"\n\nwhere ``python3.XX`` should be replaced by the appropriate python version.\n\nndfes has dependencies on ``blas/lapack`` and ``nlopt``.\nThe ``cmake`` configuration will check if these libraries are available.\nIf they are not available, it will automatically download them from\ngithub and install them.\n\nThe ``blas/lapack`` libraries are installed from the openblas package.\n   https://github.com/OpenMathLib/OpenBLAS\nThe ``nlopt`` software is used to perform nonlinear optimizations.\n   https://github.com/stevengj/nlopt\n\nThese libraries could also be installed globally using your system's\npackage manager. For example, on Fedora, you could install them with::\n\n   sudo dnf install NLopt-devel openblas\n\nSee the contents of ``build/run_cmake.sh`` to see how you can adjust\nthe compilers, compiler flags, python interpreter, and installation\ndirectory.",
    "bugtrack_url": null,
    "license": null,
    "summary": "Companion library to the ndfes C++ program for analyzing umbrella sampling",
    "version": "3.5.1",
    "project_urls": null,
    "split_keywords": [
        "ndfes"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9aae5677cc9691451f74df8fb00e5c4845290d74fff0ab8416ea1a78f86a5091",
                "md5": "7c0e24bc0fff509a7dd1aa6350b3ba36",
                "sha256": "f29edfc23d532f2ad854691f9bda24e260fafed2fc6f0ef8d7a4a4cc744fe2dc"
            },
            "downloads": -1,
            "filename": "ndfes-3.5.1-py2.py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl",
            "has_sig": false,
            "md5_digest": "7c0e24bc0fff509a7dd1aa6350b3ba36",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 22541791,
            "upload_time": "2025-07-16T19:28:14",
            "upload_time_iso_8601": "2025-07-16T19:28:14.500310Z",
            "url": "https://files.pythonhosted.org/packages/9a/ae/5677cc9691451f74df8fb00e5c4845290d74fff0ab8416ea1a78f86a5091/ndfes-3.5.1-py2.py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f32173467969aea74f44e5f7aa277c2b151d286b142e1ab647b9768ecf486bb9",
                "md5": "7f1f2a6cedc294368de1343aa13f62f3",
                "sha256": "8852ef36253510f105ffd5f210348bff66217e98cb0c6ba4b1657cf43dc7912e"
            },
            "downloads": -1,
            "filename": "ndfes-3.5.1-py2.py3-none-musllinux_1_2_x86_64.whl",
            "has_sig": false,
            "md5_digest": "7f1f2a6cedc294368de1343aa13f62f3",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 24608192,
            "upload_time": "2025-07-16T19:28:16",
            "upload_time_iso_8601": "2025-07-16T19:28:16.712594Z",
            "url": "https://files.pythonhosted.org/packages/f3/21/73467969aea74f44e5f7aa277c2b151d286b142e1ab647b9768ecf486bb9/ndfes-3.5.1-py2.py3-none-musllinux_1_2_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-16 19:28:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ndfes"
}
        
Elapsed time: 0.77931s