Skip to content

Commit

Permalink
Rename cf_units to cf-units (#113)
Browse files Browse the repository at this point in the history
* 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" {};' \;
```
  • Loading branch information
pelson authored Jun 2, 2018
1 parent caad21f commit 23610d4
Show file tree
Hide file tree
Showing 20 changed files with 104 additions and 112 deletions.
34 changes: 13 additions & 21 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
You can either install cf_units using the conda package manager or from source.
You can either install cf-units using the conda package manager or from source.

Installing using conda
----------------------

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

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

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

conda install -c conda-forge cf_units
conda install -c conda-forge cf-units

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

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

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

python setup.py install

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

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

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

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

Optional
''''''''
These packages are required for the full cf_units test suite to run.
These packages are required for the full cf-units test suite to run.

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


Packaged distributions
======================
The Enthought Python Distribution (EPD)
http://www.enthought.com/products/epd.php for Windows, OS X or
Redhat provides some of the dependencies for cf_units as does `Python (x, y)
http://www.pythonxy.com/ which tends to be updated a
bit more frequently.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center" style="margin:1em;">
<a href="https://scitools.org.uk/cf_units/docs/latest/">cf_units</a>
<a href="https://scitools.org.uk/cf-units/docs/latest/">cf-units</a>
</h1>

<h4 align="center">
Expand All @@ -9,20 +9,20 @@ conventions.

<p align="center">
<!-- https://shields.io/ is a good source of these -->
<a href="https://anaconda.org/conda-forge/cf_units">
<img src="https://img.shields.io/conda/dn/conda-forge/cf_units.svg"
<a href="https://anaconda.org/conda-forge/cf-units">
<img src="https://img.shields.io/conda/dn/conda-forge/cf-units.svg"
alt="conda-forge downloads" /></a>
<a href="https://github.com/SciTools/cf_units/releases">
<img src="https://img.shields.io/github/tag/SciTools/cf_units.svg"
<a href="https://github.com/SciTools/cf-units/releases">
<img src="https://img.shields.io/github/tag/SciTools/cf-units.svg"
alt="Latest version" /></a>
<a href="https://github.com/SciTools/cf_units/commits/master">
<img src="https://img.shields.io/github/commits-since/SciTools/cf_units/latest.svg"
<a href="https://github.com/SciTools/cf-units/commits/master">
<img src="https://img.shields.io/github/commits-since/SciTools/cf-units/latest.svg"
alt="Commits since last release" /></a>
<a href="https://github.com/SciTools/cf_units/graphs/contributors">
<img src="https://img.shields.io/github/contributors/SciTools/cf_units.svg"
<a href="https://github.com/SciTools/cf-units/graphs/contributors">
<img src="https://img.shields.io/github/contributors/SciTools/cf-units.svg"
alt="# contributors" /></a>
<a href="https://travis-ci.org/SciTools/cf_units/branches">
<img src="https://api.travis-ci.org/repositories/SciTools/cf_units.svg?branch=master"
<a href="https://travis-ci.org/SciTools/cf-units/branches">
<img src="https://api.travis-ci.org/repositories/SciTools/cf-units.svg?branch=master"
alt="Travis-CI" /></a>
<!-- <a href="https://zenodo.org/badge/latestdoi/5282596">
<img src="https://zenodo.org/badge/5282596.svg"
Expand Down Expand Up @@ -59,7 +59,7 @@ conventions.
Provision of a wrapper class to support Unidata/UCAR UDUNITS-2 library, and the
cftime calendar functionality.

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

### Example

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

## License and copyright

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

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

Expand Down
8 changes: 4 additions & 4 deletions cf_units/__init__.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2015 - 2018, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
"""
Units of measure.
Expand Down
8 changes: 4 additions & 4 deletions cf_units/_udunits2.pxd
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2016, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.

cdef extern from "udunits2.h":
ctypedef struct ut_system:
Expand Down
8 changes: 4 additions & 4 deletions cf_units/_udunits2.pyx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2016-2017, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
"""
Units of measure.
Expand Down
8 changes: 4 additions & 4 deletions cf_units/config.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2010 - 2018, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.


from __future__ import (absolute_import, division, print_function)
Expand Down
8 changes: 4 additions & 4 deletions cf_units/tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2010 - 2018, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.

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

from __future__ import (absolute_import, division, print_function)
Expand Down
8 changes: 4 additions & 4 deletions cf_units/tests/integration/test_date2num.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2016 - 2018, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.
"""Test function :func:`cf_units.date2num`."""

from __future__ import (absolute_import, division, print_function)
Expand Down
16 changes: 8 additions & 8 deletions cf_units/tests/test_coding_standards.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# (C) British Crown Copyright 2013 - 2018, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.

from __future__ import (absolute_import, division, print_function)
from six.moves import (filter, input, map, range, zip) # noqa
Expand All @@ -35,20 +35,20 @@
LICENSE_TEMPLATE = """
# (C) British Crown Copyright {YEARS}, Met Office
#
# This file is part of cf_units.
# This file is part of cf-units.
#
# cf_units is free software: you can redistribute it and/or modify it under
# cf-units is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# cf_units is distributed in the hope that it will be useful,
# cf-units is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with cf_units. If not, see <http://www.gnu.org/licenses/>.""".strip()
# along with cf-units. If not, see <http://www.gnu.org/licenses/>.""".strip()


LICENSE_RE_PATTERN = re.escape(LICENSE_TEMPLATE).replace('\{YEARS\}', '(.*?)')
Expand Down
Loading

0 comments on commit 23610d4

Please sign in to comment.