Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2026, The Trustees of Columbia University in the City of New York.
Copyright (c) 2026, diffpy.stretched-nmf contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
25 changes: 4 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,40 +58,23 @@ If you use diffpy.stretched-nmf in a scientific publication, we would like you t
Installation
------------

The preferred method is to use `Miniconda Python
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
and install from the "conda-forge" channel of Conda packages.

To add "conda-forge" to the conda channels, run the following in a terminal. ::
The preferred method is conda::

conda config --add channels conda-forge

We want to install our packages in a suitable conda environment.
The following creates and activates a new environment named ``diffpy.stretched-nmf_env`` ::

conda create -n diffpy.stretched-nmf_env diffpy.stretched-nmf
conda activate diffpy.stretched-nmf_env

The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.stretched-nmf_env`` environment, type ::
Alternatively, install from PyPI with pip::

pip install diffpy.stretched-nmf

If you prefer to install from sources, after installing the dependencies, obtain the source archive from
`GitHub <https://github.com/diffpy/diffpy.stretched-nmf/>`_. Once installed, ``cd`` into your ``diffpy.stretched-nmf`` directory
and run the following ::
For source installs (after cloning the repo)::

pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type ::
Quick check::

diffpy.stretched-nmf --version

You can also type the following command to verify the installation. ::

python -c "import diffpy.stretched_nmf; print(diffpy.stretched_nmf.__version__)"


Expand Down
2 changes: 1 addition & 1 deletion docs/source/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT
=============================
BSD 3-Clause License

Copyright (c) 2026, The Trustees of Columbia University in the City of New York.
Copyright (c) 2026, diffpy.stretched-nmf contributors
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
Loading
Loading