COAL, coal, PyCOAL, Pycoal, pycoal

[ghost]

Currently all five variations "COAL", "coal", "PyCOAL", "Pycoal", and "pycoal" are in use in our code and documentation:

$ grep -i 'pycoal' *
grep: docs: Is a directory
grep: examples: Is a directory
grep: pycoal: Is a directory
README.md:# pycoal
README.md:[![license](https://img.shields.io/github/license/capstone-coal/pycoal.svg?maxAge=2592000?style=plastic)](ht
tp://www.apache.org/licenses/LICENSE-2.0)                                                                            
README.md:[![Build Status](https://travis-ci.org/capstone-coal/pycoal.svg?branch=master)](https://travis-ci.org/capsto
ne-coal/pycoal)                                                                                                      
README.md:[![PyPI](https://img.shields.io/pypi/v/pycoal.svg?maxAge=2592000?style=plastic)](https://pypi.python.org/pyp
i/pycoal)                                                                                                            
README.md:[![Launch Binder](https://img.shields.io/badge/launch-binder-e66581.svg?style=plastic)](http://mybinder.org/
repo/capstone-coal/pycoal)                                                                                           
README.md:[![Documentation](https://readthedocs.org/projects/pycoal/badge/?version=latest)](http://pycoal.readthedocs.
io/en/latest/)                                                                                                       
README.md:[![Requirements Status](https://requires.io/github/capstone-coal/pycoal/requirements.svg?branch=master)](htt
ps://requires.io/github/capstone-coal/pycoal/requirements/?branch=master)                                            
README.md:[![Code Health](https://landscape.io/github/capstone-coal/pycoal/master/landscape.svg?style=plastic)](https:
//landscape.io/github/capstone-coal/pycoal/master)                                                                   
README.md:**pycoal provides a suite of algorithms (written in Python) to identify, classify, characterize, and quantif
y (by reporting a number of key metrics) the direct and indirect impacts of MTM and related destructive surface mining
 activities across the continental U.S.A (and further afield)**.                                                     
README.md:pip install pycoal
README.md:conda install -c conda-forge pycoal
README.md:git clone https://github.com/capstone-coal/pycoal.git && cd pycoal
README.md:[![Launch Binder](https://img.shields.io/badge/launch-binder-e66581.svg?style=plastic)](http://mybinder.org/
repo/capstone-coal/pycoal)                                                                                           
README.md:In the [examples directory](https://github.com/capstone-coal/pycoal/tree/master/examples) you can find sever
al Jupyter notebooks with specific applications of coal. You can launch a cloud Jupyter server using binder to edit th
e notebooks without installing anything. Try it out!                                                                 
README.md:http://mybinder.org/repo/capstone-coal/pycoal
README.md:PyCOAL documentation can be found at http://pycoal.readthedocs.io however you can also build documentation m
anually.                                                                                                             
README.md:Pycoal uses the popular [nose](http://nose.readthedocs.io/en/latest/testing.html) testing framework. Tests c
an be run as follows                                                                                                 
setup.py:_download_url = 'http://pypi.python.org/pypi/pycoal/'
setup.py:_name = 'pycoal'
setup.py:_test_suite = 'pycoal.tests'
setup.py:_url = 'https://github.com/capstone-coal/pycoal'
$ grep -Ri 'pycoal' docs/source/* | grep -vi _build                 
docs/source/conf.py:sys.path.insert(0, os.path.abspath('../../pycoal'))
docs/source/conf.py:project = u'pycoal'
docs/source/environment.rst:.. autoclass:: pycoal.environment.EnvironmentalCorrelation
docs/source/index.rst:Welcome to pycoal's documentation!
docs/source/introduction.rst:What is Pycoal?
docs/source/introduction.rst:pycoal provides a suite of algorithms (written in Python) to identify, classify, characte
rize, and quantify (by reporting a number of key metrics) the direct and indirect impacts of MTM and related destructi
ve surface mining activities across the continental U.S.A (and further afield).                                      
docs/source/introduction.rst:More information on COAL can be found at the `project website <https://capstone-coal.gith
ub.io/>`_ as well as the `course documents directory <https://github.com/capstone-coal/pycoal/tree/master/docs/course>
`_.                                                                                                                  
docs/source/mineral.rst:.. autoclass:: pycoal.mineral.MineralClassification
docs/source/mineral.rst:.. autoclass:: pycoal.mineral.AsterConversion
docs/source/mining.rst:.. autoclass:: pycoal.mining.MiningClassification
docs/source/quickstart.rst:In the `examples directory <https://github.com/capstone-coal/pycoal/tree/master/examples>`_
 you can find several Jupyter notebooks with specific applications of coal. You can launch a cloud Jupyter server usin
g binder to edit the notebooks without installing anything. `Try it out <http://mybinder.org/repo/capstone-coal/pycoal
>`_!                                                                                                                 
$ grep -Ri 'pycoal' pycoal/ | grep -v ^Binary
pycoal/mining.py:import pycoal
pycoal/mining.py:        Classify mines or other features in a PyCOAL mineral classified image by
pycoal/mining.py:                'description': 'PyCOAL '+pycoal.version+' mining classified image.',
pycoal/tests/mining_test.py:import pycoal
pycoal/tests/mining_test.py:import pycoal.mining
pycoal/tests/mining_test.py:    mc = pycoal.mining.MiningClassification()
pycoal/tests/test.py:    os.chdir('pycoal/tests')
pycoal/tests/images/ang20150422t163638_corr_v1e_img_987_654_rgb.hdr:  PyCOAL 0.2 three-band RGB image.}
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut_NHDFlowline_corr.hdr:  PyCOAL 0.5-dev environment
al correlation image.}                                                                                               
pycoal/tests/images/ang20150422t163638_corr_v1e_img_4000-4010_550-560_class.hdr:  PyCOAL 0.2 mineral classified image.
}                                                                                                                    
pycoal/tests/images/ang20150420t182808_corr_v1e_img_class_mining_4200-4210_70-80.hdr:  PyCOAL 0.2 mining classified im
age.}                                                                                                                
pycoal/tests/images/ang20150420t182808_corr_v1e_img_class_4200-4210_70-80.hdr:  PyCOAL 0.2 mineral classified image.}
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut.hdr:/media/study/OSU/spring17/cs463/coal/pycoal/t
ests/images/ang20150420t182050_corr_v1e_img_class_mining_cut.img}                                                    
pycoal/tests/images/f080702t01p00r08rdn_c_sc01_ort_img_123_456_rgb.hdr:  PyCOAL 0.2 three-band RGB image.}
pycoal/tests/images/ang20140912t192359_corr_v1c_img_2580-2590_540-550_class.hdr:  PyCOAL 0.2 mineral classified image.
}                                                                                                                    
pycoal/tests/images/ang20140912t192359_corr_v1c_img_400-410_10-20_class.hdr:  PyCOAL 0.2 mineral classified image.}
pycoal/tests/images/ang20140912t192359_corr_v1c_img_400-410_10-20_rgb.hdr:  PyCOAL 0.3-dev three-band RGB image.}
pycoal/tests/mineral_test.py:import pycoal
pycoal/tests/mineral_test.py:from pycoal import mineral
pycoal/tests/mineral_test.py:from pycoal import mining
pycoal/tests/mineral_test.py:        assert actual.metadata.get(u'description') == 'PyCOAL '+pycoal.version+' mineral 
classified image.'                                                                                                   
pycoal/tests/environment_test.py~:import pycoal
pycoal/tests/environment_test.py:import pycoal
pycoal/tests/environment_test.py:from pycoal import environment
pycoal/tests/environment_test.py:    assert actual.metadata.get('description') == 'PyCOAL '+pycoal.version+' environme
ntal correlation image.'                                                                                             
pycoal/mineral.py:import pycoal
pycoal/mineral.py:        ``pycoal.mineral.AsterConversion.convert()``.
pycoal/mineral.py:                'description': 'PyCOAL '+pycoal.version+' mineral classified image.',
pycoal/mineral.py:        pycoal.mineral.MineralClassification.filterClasses(classifiedFilename)
pycoal/mineral.py:        rgbMetadata['description'] = 'PyCOAL '+pycoal.version+' three-band RGB image.'
pycoal/environment.py:import pycoal
pycoal/environment.py:                'description': 'PyCOAL '+pycoal.version+' environmental correlation image.',
pycoal/environment.py:        Create an empty copy of a PyCOAL classified image with the same size.

And on the website:

$ grep -Ri pycoal . | grep -v _site
./_includes/header.html:    <a class="github-fork-ribbon" href="https://github.com/capstone-coal/pycoal" title="Fork m
e on GitHub">Fork me on GitHub</a>                                                                                   
./index.html:          <p>Read the <a href="docs">documentation</a> to learn how to install and use the Python COAL pa
ckage <a class="external" href="https://pypi.python.org/pypi/pycoal"><code>pycoal</code></a>.</p>                    
./index.html:            <li>Browse the <a class="external" href="https://pycoal.readthedocs.io/en/latest/">API refere
nce</a> for detailed class and method documentation,</li>                                                            
./index.html:            <li>View development documentation on our <a class="external" href="https://github.com/capsto
ne-coal/pycoal/wiki">wiki</a>.</li>                                                                                  
./docs.html:<p>This section will describe how to install the Python COAL package <a class="external" href="https://pyp
i.python.org/pypi/pycoal"><code>pycoal</code></a> from the Python Package Index (PyPI).</p>                          
./docs.html:<p>This section will demonstrate basic usage of the Python COAL library and link to the detailed <a class=
"external" href="https://pycoal.readthedocs.io/en/latest/">API reference</a>.</p>                                    
./docs.html:<p>This section will discuss how to contribute to the project through our <a class="external" href="https:
//github.com/capstone-coal">GitHub Organization</a> and refer to the COAL <a class="external" href="https://github.com
/capstone-coal/pycoal/wiki">wiki</a> for development documentation.</p>                                              

This was discussed in a previous issue but not resolved. A decision made was to refer to the project as "COAL" and the Python package as pycoal. This issue could either update the code and documentation or consider additional alternatives.

Assigning initially to @lewismc to confirm naming conventions and then delegate as necessary.

[ghost]

Also affects the Wiki.

[lewismc]

ACK, lets stick with the following "...to refer to the project as "COAL" and the Python package as pycoal"

[ghost]

Sure thing, apologies for the inconsistent usage. Assigning to self to make the changes which can be merged in a future revision. This will include changes to the image metadata.

[ghost]

We will probably want to follow this convention in future git tags as well:

$ git tag -l | xargs git show --format=oneline --no-patch | grep -ie "^\w*coal"                                                                                                          
PyCOAL 0.1
PyCOAL 0.2.0
PyCOAL 0.5.0
PyCOAL 0.5.1

[ghost]

More concise list of the affected files:

$ grep -lis 'pycoal' *
README.md
setup.py
$ grep -Rils 'pycoal' docs/source/* | grep -vi _build               
docs/source/conf.py
docs/source/environment.rst
docs/source/index.rst
docs/source/introduction.rst
docs/source/mineral.rst
docs/source/mining.rst
docs/source/quickstart.rst
$ grep -Rils 'pycoal' pycoal/ | grep -v ^Binary | grep -v "pyc$"
pycoal/mining.py
pycoal/tests/mining_test.py
pycoal/tests/test.py
pycoal/tests/images/ang20150422t163638_corr_v1e_img_987_654_rgb.hdr
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut_NHDFlowline_corr.hdr
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut_NHDFlowline_corr.img.aux.xml
pycoal/tests/images/ang20150422t163638_corr_v1e_img_4000-4010_550-560_class.hdr
pycoal/tests/images/ang20150420t182808_corr_v1e_img_class_mining_4200-4210_70-80.hdr
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut.img.aux.xml
pycoal/tests/images/ang20150420t182808_corr_v1e_img_class_4200-4210_70-80.hdr
pycoal/tests/images/ang20150420t182050_corr_v1e_img_class_mining_cut.hdr
pycoal/tests/images/f080702t01p00r08rdn_c_sc01_ort_img_123_456_rgb.hdr
pycoal/tests/images/ang20140912t192359_corr_v1c_img_2580-2590_540-550_class.hdr
pycoal/tests/images/ang20140912t192359_corr_v1c_img_400-410_10-20_class.hdr
pycoal/tests/images/ang20140912t192359_corr_v1c_img_400-410_10-20_rgb.hdr
pycoal/tests/mineral_test.py
pycoal/tests/environment_test.py
pycoal/mineral.py
pycoal/environment.py

[ghost]

Pull https://github.com/capstone-coal/pycoal/issues/98 addresses the changes to the source. The website did not need to be updated. I also modified the wiki pages including the release instructions which will properly document the tagging in the future.

"COAL" (always all-caps) should now be used consistently to name the project and the library, and pycoal (lowercase and preferably in code style) should be used only to refer to the Python COAL package and module name.

[ghost]

Merged and closed.