Skip to content

Commit 23610d4

Browse files
authored
Rename cf_units to cf-units (#113)
* Updated name to cf-units. * Updated the copyright and README/INSTALL. Copyright updated automatically with: ``` LC_ALL=C find . \ -path ./.git -prune \ -o -type f -name "*" \ -exec echo {} \; \ -exec sh -c 'perl -pi -e "s|This file is part of cf-units|This file is part of cf-units|g" {};' \; \ -exec sh -c 'perl -pi -e "s|cf-units is free software|cf-units is free software|g" {};' \; \ -exec sh -c 'perl -pi -e "s|cf-units is distributed in|cf-units is distributed in|g" {};' \; \ -exec sh -c 'perl -pi -e "s|along with cf-units|along with cf-units|g" {};' \; ```
1 parent caad21f commit 23610d4

20 files changed

Lines changed: 104 additions & 112 deletions

INSTALL

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
You can either install cf_units using the conda package manager or from source.
1+
You can either install cf-units using the conda package manager or from source.
22

33
Installing using conda
44
----------------------
55

6-
cf_units is available using conda for the following platforms:
6+
cf-units is available using conda for the following platforms:
77
* Linux 32-bit and 64-bit,
88
* Mac OSX 64-bit, and
99
* Windows 32-bit and 64-bit.
1010

11-
To install cf_units using conda, you must first download and install conda,
11+
To install cf-units using conda, you must first download and install conda,
1212
for example from http://conda.pydata.org/miniconda.html.
1313

14-
Once conda is installed, you can install cf_units using conda on any platform with
14+
Once conda is installed, you can install cf-units using conda on any platform with
1515
the following command::
1616

17-
conda install -c conda-forge cf_units
17+
conda install -c conda-forge cf-units
1818

1919
Further documentation on using conda and the features it provides can be found
2020
at http://conda.pydata.org/docs/intro.html.
@@ -23,13 +23,13 @@ at http://conda.pydata.org/docs/intro.html.
2323
Installing from source
2424
----------------------
2525

26-
The latest cf_units source release is available from
27-
https://github.com/SciTools/cf_units.
26+
The latest cf-units source release is available from
27+
https://github.com/SciTools/cf-units.
2828

29-
cf_units makes use of Numpy, netCDF4-python, Cython, and Unidata udunits2.
29+
cf-units makes use of Numpy, netCDF4-python, Cython, and Unidata udunits2.
3030
These dependencies must be in place before you can successfully install
31-
cf_units. Once you have satisfied the requirements detailed below,
32-
extract the cf_units source package, cd to the new directory, and enter::
31+
cf-units. Once you have satisfied the requirements detailed below,
32+
extract the cf-units source package, cd to the new directory, and enter::
3333

3434
python setup.py install
3535

@@ -43,7 +43,7 @@ can be provided as per-usual at build_ext phase::
4343
Build and runtime requirements
4444
==============================
4545
These are external packages which you will need to have installed before
46-
installing and running cf_units.
46+
installing and running cf-units.
4747

4848
Many of these packages are available in Linux package managers
4949
such as aptitude and yum. For example, it may be possible to install
@@ -56,7 +56,7 @@ you may need to install the development packages (look for a "-dev"
5656
postfix) in addition to the core packages.
5757

5858
python 2.7 or later (http://www.python.org/)
59-
cf_units requires Python 2.7 or later, but is not currently compatible with
59+
cf-units requires Python 2.7 or later, but is not currently compatible with
6060
Python 3.
6161

6262
numpy 1.6 or later (http://numpy.scipy.org/)
@@ -76,7 +76,7 @@ setuptools 0.6c11 or later (http://pypi.python.org/pypi/setuptools/)
7676

7777
Optional
7878
''''''''
79-
These packages are required for the full cf_units test suite to run.
79+
These packages are required for the full cf-units test suite to run.
8080

8181
pep8 1.4.6* (https://pypi.python.org/pypi/pep8)
8282
Python package for software testing.
@@ -99,11 +99,3 @@ specify a non-standard location for your udunits xml database::
9999
An example configuration file is available in ``cf_units/etc/site.cfg.template``.
100100
See :py:func:`cf_units.config` for further configuration options.
101101

102-
103-
Packaged distributions
104-
======================
105-
The Enthought Python Distribution (EPD)
106-
http://www.enthought.com/products/epd.php for Windows, OS X or
107-
Redhat provides some of the dependencies for cf_units as does `Python (x, y)
108-
http://www.pythonxy.com/ which tends to be updated a
109-
bit more frequently.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<h1 align="center" style="margin:1em;">
2-
<a href="https://scitools.org.uk/cf_units/docs/latest/">cf_units</a>
2+
<a href="https://scitools.org.uk/cf-units/docs/latest/">cf-units</a>
33
</h1>
44

55
<h4 align="center">
@@ -9,20 +9,20 @@ conventions.
99

1010
<p align="center">
1111
<!-- https://shields.io/ is a good source of these -->
12-
<a href="https://anaconda.org/conda-forge/cf_units">
13-
<img src="https://img.shields.io/conda/dn/conda-forge/cf_units.svg"
12+
<a href="https://anaconda.org/conda-forge/cf-units">
13+
<img src="https://img.shields.io/conda/dn/conda-forge/cf-units.svg"
1414
alt="conda-forge downloads" /></a>
15-
<a href="https://github.com/SciTools/cf_units/releases">
16-
<img src="https://img.shields.io/github/tag/SciTools/cf_units.svg"
15+
<a href="https://github.com/SciTools/cf-units/releases">
16+
<img src="https://img.shields.io/github/tag/SciTools/cf-units.svg"
1717
alt="Latest version" /></a>
18-
<a href="https://github.com/SciTools/cf_units/commits/master">
19-
<img src="https://img.shields.io/github/commits-since/SciTools/cf_units/latest.svg"
18+
<a href="https://github.com/SciTools/cf-units/commits/master">
19+
<img src="https://img.shields.io/github/commits-since/SciTools/cf-units/latest.svg"
2020
alt="Commits since last release" /></a>
21-
<a href="https://github.com/SciTools/cf_units/graphs/contributors">
22-
<img src="https://img.shields.io/github/contributors/SciTools/cf_units.svg"
21+
<a href="https://github.com/SciTools/cf-units/graphs/contributors">
22+
<img src="https://img.shields.io/github/contributors/SciTools/cf-units.svg"
2323
alt="# contributors" /></a>
24-
<a href="https://travis-ci.org/SciTools/cf_units/branches">
25-
<img src="https://api.travis-ci.org/repositories/SciTools/cf_units.svg?branch=master"
24+
<a href="https://travis-ci.org/SciTools/cf-units/branches">
25+
<img src="https://api.travis-ci.org/repositories/SciTools/cf-units.svg?branch=master"
2626
alt="Travis-CI" /></a>
2727
<!-- <a href="https://zenodo.org/badge/latestdoi/5282596">
2828
<img src="https://zenodo.org/badge/5282596.svg"
@@ -59,7 +59,7 @@ conventions.
5959
Provision of a wrapper class to support Unidata/UCAR UDUNITS-2 library, and the
6060
cftime calendar functionality.
6161

62-
Documentation can be found at <https://scitools.org.uk/cf_units/docs/latest/>.
62+
Documentation can be found at <https://scitools.org.uk/cf-units/docs/latest/>.
6363

6464
### Example
6565

@@ -75,13 +75,13 @@ Documentation can be found at <https://scitools.org.uk/cf_units/docs/latest/>.
7575
of related projects use the
7676
[Google Group](https://groups.google.com/forum/#!forum/scitools-iris).
7777
- Report bugs, suggest features or view the source code on
78-
[GitHub](https://github.com/SciTools/cf_units).
78+
[GitHub](https://github.com/SciTools/cf-units).
7979

8080
## License and copyright
8181

82-
cf_units is licensed under GNU Lesser General Public License (LGPLv3).
82+
cf-units is licensed under GNU Lesser General Public License (LGPLv3).
8383

84-
Development occurs on GitHub at <https://github.com/SciTools/cf_units>, with a
84+
Development occurs on GitHub at <https://github.com/SciTools/cf-units>, with a
8585
contributor's license agreement (CLA) that can be found at
8686
<https://scitools.org.uk/governance.html>.
8787

cf_units/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2015 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717
"""
1818
Units of measure.
1919

cf_units/_udunits2.pxd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2016, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717

1818
cdef extern from "udunits2.h":
1919
ctypedef struct ut_system:

cf_units/_udunits2.pyx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2016-2017, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717
"""
1818
Units of measure.
1919

cf_units/config.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2010 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717

1818

1919
from __future__ import (absolute_import, division, print_function)

cf_units/tests/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2010 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717

1818
from __future__ import (absolute_import, division, print_function)
1919
from six.moves import (filter, input, map, range, zip) # noqa
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# (C) British Crown Copyright 2016 - 2017, Met Office
1+
# (C) British Crown Copyright 2016 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.

cf_units/tests/integration/test__num2date_to_nearest_second.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2016 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717
"""Test function :func:`cf_units._num2date_to_nearest_second`."""
1818

1919
from __future__ import (absolute_import, division, print_function)

cf_units/tests/integration/test_date2num.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# (C) British Crown Copyright 2016 - 2018, Met Office
22
#
3-
# This file is part of cf_units.
3+
# This file is part of cf-units.
44
#
5-
# cf_units is free software: you can redistribute it and/or modify it under
5+
# cf-units is free software: you can redistribute it and/or modify it under
66
# the terms of the GNU Lesser General Public License as published by the
77
# Free Software Foundation, either version 3 of the License, or
88
# (at your option) any later version.
99
#
10-
# cf_units is distributed in the hope that it will be useful,
10+
# cf-units is distributed in the hope that it will be useful,
1111
# but WITHOUT ANY WARRANTY; without even the implied warranty of
1212
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1313
# GNU Lesser General Public License for more details.
1414
#
1515
# You should have received a copy of the GNU Lesser General Public License
16-
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
16+
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
1717
"""Test function :func:`cf_units.date2num`."""
1818

1919
from __future__ import (absolute_import, division, print_function)

0 commit comments

Comments
 (0)