Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Merge branch 'change-license'
Browse files Browse the repository at this point in the history
  • Loading branch information
mhucka committed Nov 18, 2019
2 parents 9befeef + 1e797f0 commit fbc0c91
Show file tree
Hide file tree
Showing 16 changed files with 530 additions and 871 deletions.
Binary file added .graphics/caltech-round.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
183 changes: 0 additions & 183 deletions .graphics/caltech-round.svg

This file was deleted.

1 change: 1 addition & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,5 @@ Please also use the DOI to **indicate the specific version of Nostril that you u
other people's ability to reproduce your results. Here are the DOIs for the
most recent releases:

* Nostril release 1.2.0 ⇒ [10.22002/D1.1313](https://data.caltech.edu/records/1313)
* Nostril release 1.1.0 ⇒ [10.22002/D1.935](https://data.caltech.edu/records/935)
1,135 changes: 486 additions & 649 deletions LICENSE

Large diffs are not rendered by default.

19 changes: 13 additions & 6 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,24 @@

This file summarizes the main changes between different versions of this package.

News since the last release
---------------------------
Version 1.2.0
-------------

* The [JOSS paper about Nostril](http://joss.theoj.org/papers/10.21105/joss.00596) has been published.
* Release 1.1.1 has a citable DOI: [10.22002/D1.935](https://data.caltech.edu/records/935).
This release only changes the license (to [LGPL](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)) and the documentation strings within code files and the [README](README.md) file; there are no code or behavioral changes in this release.


News for version 1.1.1
----------------------
Version 1.1.1
-------------

* The [JOSS paper about Nostril](http://joss.theoj.org/papers/10.21105/joss.00596) has been published.
* Release 1.1.1 has a citable DOI: [10.22002/D1.935](https://data.caltech.edu/records/935).
* Fix [`requirements.txt`](requirements.txt) to use `>=` in version comparisons instead of exact comparisons
* Fix and enhance the Nostril documentation in [docs/explanations/README.md](docs/explanations/README.md)
* Fix a broken link in [`README.md`](README.md) to the explanations document
* Add a [NEWS.md](NEWS.md) file


Version 1.1.0
-------------

Changes in this release include a fix to `setup.py` to make automatic installation of depencies work properly, updated installation instructions [below](#-installing-nostril), improvements to the [JOSS paper](docs/papers/joss/paper.pdf), a change to the command-line program to use the more conventional `-V` instead of `-v` for printing the version, and internal code refactoring.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Nostril is the _Nonsense String Evaluator_: a Python module that infers whether

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0)
[![Python](https://img.shields.io/badge/Python-3.4+-brightgreen.svg?style=flat-square)](http://shields.io)
[![Latest release](https://img.shields.io/badge/Latest_release-1.1.1-b44e88.svg?style=flat-square)](http://shields.io)
[![DOI](http://img.shields.io/badge/DOI-10.22002%20%2F%20D1.935-blue.svg?style=flat-square)](https://data.caltech.edu/records/935)
[![DOI](http://img.shields.io/badge/JOSS-10.21105%20%2f%20joss.00596-brightgreen.svg?style=flat-square)](https://doi.org/10.21105/joss.00596)
[![Latest release](https://img.shields.io/github/v/release/casics/nostril.svg?style=flat-square&color=b44e88&label=Latest%20release)](https://github.com/casics/nostril)
[![DOI](https://img.shields.io/badge/dynamic/json.svg?label=DOI&style=flat-square&colorA=gray&colorB=ff6c0c&query=$.metadata.doi&uri=https://data.caltech.edu/api/record/1313)](https://data.caltech.edu/records/1313)
[![JOSS DOI](http://img.shields.io/badge/JOSS-10.21105%20%2f%20joss.00596-navy.svg?style=flat-square)](https://doi.org/10.21105/joss.00596)

*Author*: [Michael Hucka](http://github.com/mhucka)<br>
*Author*: [Michael Hucka](http://github.com/mhucka) (ORCID: [0000-0001-9105-5960](https://orcid.org/0000-0001-9105-5960))<br>
*Code repository*: [https://github.com/casics/nostril](https://github.com/casics/nostril)<br>
*License*: Unless otherwise noted, this content is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.

🏁 Recent news and activities
------------------------------

_May 2018_: The [JOSS paper](http://joss.theoj.org/papers/10.21105/joss.00596) has been published. Also, Nostril release 1.1.1 has a citable DOI: [10.22002/D1.935](https://data.caltech.edu/records/935).
_November 2019_: Release version 1.2.0 changes the license for Nostril to LGPL version 2.1. There are no API or behavioral changes; all changes are limited to documentation strings, the [README](README.md) file, and a new DOI.

_April 2018_: Version 1.1.1 fixes the `requirements.txt` file so that instead of doing exact version comparisons, it only requires minimum versions. The release also updates the documentation in [docs/explanations](docs/explanations). Other changes (which were in release 1.1.0) include a fix to `setup.py` to make automatic installation of depencies work properly, updated installation instructions [below](#-installing-nostril), improvements to the [JOSS paper](docs/papers/joss/paper.pdf), a change to the command-line program to use the more conventional `-V` instead of `-v` for printing the version, and internal code refactoring.
The file [NEWS](NEWS.md) contains a more complete change log that includes information about previous releases.

Table of contents
-----------------
Expand Down Expand Up @@ -80,6 +80,7 @@ Hucka, M. (2018). Nostril: A nonsense string evaluator written in Python. <i>Jou

Please also use the DOI to indicate the specific version you use, to improve other people's ability to reproduce your results:

* Nostril release 1.2.0 &rArr; [10.22002/D1.1313](https://data.caltech.edu/records/1313)
* Nostril release 1.1.0 &rArr; [10.22002/D1.935](https://data.caltech.edu/records/935)

✺ Installation instructions
Expand Down Expand Up @@ -263,6 +264,6 @@ This material is based upon work supported by the [National Science Foundation](
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://www.caltech.edu">
<img width="100" height="100" src=".graphics/caltech-round.svg">
<img width="100" align="top" src=".graphics/caltech-round.png">
</a>
</div>
6 changes: 3 additions & 3 deletions nostril/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@
Copyright
---------
Copyright (c) 2017 by the California Institute of Technology. This software
was developed as part of the CASICS project, the Comprehensive and Automated
Software Inventory Creation System. For more, visit http://casics.org.
Copyright (c) 2017-2019 by the California Institute of Technology. This
software was developed as part of the CASICS project, the Comprehensive and
Automated Software Inventory Creation System. For more, visit http://casics.org.
'''

from .__version__ import __version__, __title__, __url__, __description__
Expand Down
6 changes: 3 additions & 3 deletions nostril/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
# @website https://github.com/casics/nostril
# =============================================================================

__version__ = '1.1.1'
__version__ = '1.2.0'
__title__ = 'Nostril'
__description__ = 'Nonsense String Evaluator'
__url__ = 'https://github.com/casics/nostril'
__author__ = 'Michael Hucka <mhucka@caltech.edu>'
__email__ = 'casics-team@googlegroups.com'
__license__ = 'GNU General Public License, version 3.0'
__copyright__ = 'Copyright (C) 2015-2017 by the California Institute of Technology'
__license__ = 'GNU Lesser General Public License, version 2.1'
__copyright__ = 'Copyright (C) 2015-2019 by the California Institute of Technology'
7 changes: 3 additions & 4 deletions nostril/ng.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@
Copyright
---------
Copyright (c) 2017 by the California Institute of Technology. This software
was developed as part of the CASICS project, the Comprehensive and Automated
Software Inventory Creation System. For more, visit http://casics.org.
Copyright (c) 2017-2019 by the California Institute of Technology. This
software was developed as part of the CASICS project, the Comprehensive and
Automated Software Inventory Creation System. For more, visit http://casics.org.
'''

from collections import namedtuple
Expand Down
7 changes: 3 additions & 4 deletions nostril/nonsense_detector.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,9 @@
Copyright
---------
Copyright (c) 2017 by the California Institute of Technology. This software
was developed as part of the CASICS project, the Comprehensive and Automated
Software Inventory Creation System. For more, visit http://casics.org.
Copyright (c) 2017-2019 by the California Institute of Technology. This
software was developed as part of the CASICS project, the Comprehensive and
Automated Software Inventory Creation System. For more, visit http://casics.org.
'''

from collections import defaultdict
Expand Down
7 changes: 3 additions & 4 deletions nostril/training/optimize.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,9 @@
Copyright
---------
Copyright (c) 2017 by the California Institute of Technology. This software
was developed as part of the CASICS project, the Comprehensive and Automated
Software Inventory Creation System. For more, visit http://casics.org.
Copyright (c) 2017-2019 by the California Institute of Technology. This
software was developed as part of the CASICS project, the Comprehensive and
Automated Software Inventory Creation System. For more, visit http://casics.org.
'''

from contextlib import redirect_stdout
Expand Down
7 changes: 3 additions & 4 deletions nostril/training/training.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,9 @@
Copyright
---------
Copyright (c) 2017 by the California Institute of Technology. This software
was developed as part of the CASICS project, the Comprehensive and Automated
Software Inventory Creation System. For more, visit http://casics.org.
Copyright (c) 2017-2019 by the California Institute of Technology. This
software was developed as part of the CASICS project, the Comprehensive and
Automated Software Inventory Creation System. For more, visit http://casics.org.
'''

import os
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# @author Michael Hucka
#
# <!---------------------------------------------------------------------------
# Copyright (C) 2015 by the California Institute of Technology.
# Copyright (C) 2015-2019 by the California Institute of Technology.
# This software is part of CASICS, the Comprehensive and Automated Software
# Inventory Creation System. For more information, visit http://casics.org.
# ------------------------------------------------------------------------- -->
Expand Down
2 changes: 1 addition & 1 deletion tests/labeled-cases/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Labeled test cases
==================

`real-not-real.csv` was derived from the strings returned by an early version of the CASICS word extractor. The "words" included many strings that were obviously random or garbage, but their origin were unclear. (This lead to the need to develop a tester in the first place, in fact.)
`real-not-real.csv` was derived from the strings returned by an early version of the CASICS word extractor. The "words" included many strings that were obviously random or garbage, but their origin were unclear. (This led to the need to develop a tester in the first place, in fact.)

`real-not-real.csv` is a set of nearly 5000 strings that have been hand-labeled to indicate whether they should be considered junk/random, or human-generated strings (most likely identifiers in source code). The strings may be multiple words concatenated together, as often happens when programmers create identifiers.

Expand Down
2 changes: 1 addition & 1 deletion utils/extract-loyola-ids-clean.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# @author Michael Hucka
#
# <!---------------------------------------------------------------------------
# Copyright (C) 2015 by the California Institute of Technology.
# Copyright (C) 2015-2019 by the California Institute of Technology.
# This software is part of CASICS, the Comprehensive and Automated Software
# Inventory Creation System. For more information, visit http://casics.org.
# ------------------------------------------------------------------------- -->
Expand Down
2 changes: 1 addition & 1 deletion utils/extract-symbols
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# @brief Extract unique symbols from files given as arguments.
# @author Michael Hucka
# -----------------------------------------------------------------------------
# Copyright (C) 2015 by the California Institute of Technology.
# Copyright (C) 2015-2019 by the California Institute of Technology.
# This software is part of CASICS, the Comprehensive and Automated Software
# Inventory Creation System. For more information, visit http://casics.org.
# -----------------------------------------------------------------------------
Expand Down

0 comments on commit fbc0c91

Please sign in to comment.