Skip to content

Commit 9e8f89f

Browse files
john-halloranJohn Halloran
andauthored
fix: remove extraneous files and fix CI (#192)
* fix: remove extraneous files * fix: link to correct CI script * chore: initial update to license * docs: match installation instructions between README and docs --------- Co-authored-by: John Halloran <jhalloran@oxy.edu>
1 parent d6b2011 commit 9e8f89f

8 files changed

Lines changed: 29 additions & 1079 deletions

File tree

File renamed without changes.

LICENSE.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

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

66
Redistribution and use in source and binary forms, with or without

README.rst

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -58,40 +58,23 @@ If you use diffpy.stretched-nmf in a scientific publication, we would like you t
5858
Installation
5959
------------
6060

61-
The preferred method is to use `Miniconda Python
62-
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
63-
and install from the "conda-forge" channel of Conda packages.
64-
65-
To add "conda-forge" to the conda channels, run the following in a terminal. ::
61+
The preferred method is conda::
6662

6763
conda config --add channels conda-forge
68-
69-
We want to install our packages in a suitable conda environment.
70-
The following creates and activates a new environment named ``diffpy.stretched-nmf_env`` ::
71-
7264
conda create -n diffpy.stretched-nmf_env diffpy.stretched-nmf
7365
conda activate diffpy.stretched-nmf_env
7466

75-
The output should print the latest version displayed on the badges above.
76-
77-
If the above does not work, you can use ``pip`` to download and install the latest release from
78-
`Python Package Index <https://pypi.python.org>`_.
79-
To install using ``pip`` into your ``diffpy.stretched-nmf_env`` environment, type ::
67+
Alternatively, install from PyPI with pip::
8068

8169
pip install diffpy.stretched-nmf
8270

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

8773
pip install .
8874

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

9177
diffpy.stretched-nmf --version
92-
93-
You can also type the following command to verify the installation. ::
94-
9578
python -c "import diffpy.stretched_nmf; print(diffpy.stretched_nmf.__version__)"
9679

9780

docs/source/license.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT
99
=============================
1010
BSD 3-Clause License
1111

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

1515
Redistribution and use in source and binary forms, with or without

0 commit comments

Comments
 (0)