Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Closes GH-588: updated license info in docs to Apache V2.0 and added …

…LICENSE.tst to top level of repo.
  • Loading branch information...
commit 58408dc7932613f99d795b6519d4224d6f9bfe6f 1 parent 228507f
@pziegfeld pziegfeld authored
View
13 LICENSE.txt
@@ -0,0 +1,13 @@
+OpenMDAO Open Source License:
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
View
2  docs/dev-guide/intro.rst
@@ -283,7 +283,7 @@ The directory structure of your repository should look like this:
The directory containing source to be packaged into distributions that can
be released separately from OpenMDAO. These distributions may or may not depend upon
OpenMDAO. Distributions that have not yet been approved to be part of
- ``openmdao.lib`` can live here -- as long as their license is compatible with NOSA. No
+ ``openmdao.lib`` can live here -- as long as their license is compatible with Apache V2.0. No
proprietary code or GPL code should be placed in the OpenMDAO-Framework repository.
``devenv``
View
82 docs/dev-guide/scripts.rst
@@ -12,14 +12,14 @@ General Setup
Information about remote hosts is contained in a config file. An example
of such a file is ``config/testhosts.cfg`` in the
OpenMDAO-Framework repository. This file should be copied to
-``~/.openmdao/testhosts.cfg`` and modified to contain the hosts or ec2 images
+``~/.openmdao/testhosts.cfg`` and modified to contain the hosts or EC2 images
you intend to test on. The scripts look for this file in ``~/.openmdao``
by default. You can specify a different config file on the command line using
the ``-c`` argument.
Aside from the [DEFAULT] section, the file has one section per
host or EC2 image. The section name is used as a short alias for that host
-and is used with the --host=<section_name> arg in the testing scripts.
+and is used with the ``--host=<section_name>`` arg in the testing scripts.
EC2 Specific Setup
@@ -27,7 +27,7 @@ EC2 Specific Setup
To run the scripts on EC2 images or non-running instances, you must create
a ``~/.boto`` config file with the appropriate id and secret key. You may
-also specify other information in the .boto file, e.g., debug level. An
+also specify other information in the ``.boto file``, e.g., debug level. An
example of a ``.boto`` file is shown below.
@@ -51,13 +51,13 @@ SSH keys
~~~~~~~~
You'll need an identity file to execute operations like starting and
-stopping instances on EC2 using the *boto* package. For openmdao
+stopping instances on EC2 using the *boto* package. For OpenMDAO
we use an identity file called ``lovejoy.pem`` for all of our EC2 images
and instances. The identity file should be placed in the ``~/.ssh`` directory.
-In order to actually connect to a given host via SSH, you'll need to take
-your personal public key for the host your're connecting from and put it
-in the authorized_keys file on the destination host. This is true whether
+To actually connect to a given host via SSH, you'll need to take
+your personal public key for the host you're connecting from and put it
+in the ``authorized_keys`` file on the destination host. This is true whether
the host is an EC2 host or not.
@@ -65,16 +65,15 @@ Scripts
-------
The following section describes each script in detail. All scripts accept the
-**-h** and the **--help** command line options which will display all of their
+``-h`` and the ``--help`` command line options which will display all of their
allowed arguments.
test_branch
~~~~~~~~~~~
-The *test_branch* script is used to test a branch using *openmdao_test*
-run on a group of remote hosts. Running it with
-a **-h** option shows the following:
+The ``test_branch`` script is used to test a branch running ``openmdao_test``
+on a group of remote hosts. Running it with a ``-h`` option will display the following:
::
@@ -100,20 +99,19 @@ a **-h** option shows the following:
The tests run concurrently and write their outputs to
-<outdir>/<host_config_name>/run.out where *outdir* defaults to ``host_results``
-and *host_config_name* is the section name for that host in the config file.
+``<outdir>/<host_config_name>/run.out`` where ``outdir`` defaults to ``host_results``,
+and ``host_config_name`` is the section name for that host in the config file.
-The --host arg can be used multiple times in order to specify more than one
-host.
+The ``--host`` arg can be used multiple times to specify more than one host.
The script can test the current (committed) branch of a Git repository,
-a tarred repository, or a specific branch of a specified local or remote git
+a tarred repository, or a specific branch of a specified local or remote Git
repository. If a Git repository is specified rather than a tar file, then
-the branch must also be specified. If no **-f** is supplied, the current
+the branch must also be specified. If no ``-f`` is supplied, the current
branch of the current repository is used.
-If a **--** arg is supplied, any args after that are passed to openmdao_test
-on the remote host. Adding a **-x** arg after the **--** arg, for example,
+If a ``--`` arg is supplied, any args after that are passed to openmdao_test
+on the remote host. Adding a ``-x`` arg after the ``--`` arg, for example,
would cause the test to end as soon as any test on the remote host failed.
Adding the name of a specific module to test can also be a big time saver
when debugging a specific test failure.
@@ -122,10 +120,10 @@ when debugging a specific test failure.
test_release
~~~~~~~~~~~~
-The test_release script is used to test a release using *openmdao_test*
-run on a group of remote hosts. It can also be used to test an existing
-production release on a specific host. Running it with a **-h** option
-shows the following:
+The ``test_release`` script is used to test a release by running ``openmdao_test``
+on a group of remote hosts. It can also be used to test an existing
+production release on a specific host. Running it with a ``-h`` option
+will display the following:
::
@@ -148,9 +146,9 @@ shows the following:
URL or pathname of a go-openmdao.py file or pathname
of a release dir
-The **-f** argument is used to specify either the ``go-openmdao.py`` file that
-builds the release environment, or the path to a directory that was built
-using the *make_release* script.
+The ``-f`` argument is used to specify either the ``go-openmdao.py`` file that
+builds the release environment or the path to a directory that was built
+using the ``make_release`` script.
Release Building and Publishing
@@ -164,10 +162,10 @@ easier.
Release Creation
----------------
-The *make_release* script is used to build the required distribution tar
+The ``make_release`` script is used to build the required distribution tar
files for all of the OpenMDAO packages. It also builds the html version
-of the docs and the go-openmdao.py bootstrapping installer file.
-Running *make_release* with a **-h** option shows the following:
+of the docs and the ``go-openmdao.py`` bootstrapping installer file.
+Running ``make_release`` with a ``-h`` option will display the following:
::
@@ -192,18 +190,18 @@ Running *make_release* with a **-h** option shows the following:
The script places all of the tar files and docs in the destination directory
-specified with the **-d** option. The version number is specified with **-v**
-and must be later than any version already existing on openmdao.org. OpenMDAO
+specified with the ``-d`` option. The version number is specified with ``-v``
+and must be later than any version already existing on ``openmdao.org``. OpenMDAO
releases require binary distributions on Windows for certain packages, so
-*make_release* will fail if you don't specify a Windows host using the
-**--host** option. The **-t** and **-n** options should only be used for
-testing purposes.
+``make_release`` will fail if you don't specify a Windows host using the
+``--host`` option. The ``-t`` and ``-n`` options should be used for
+testing purposes only.
Release Testing
~~~~~~~~~~~~~~~
-See the previous description of *test_release*.
+See the previous description of ``test_release``.
Making an Official Release
@@ -211,21 +209,21 @@ Making an Official Release
Once all of the distribution packages have been made and the release has
been tested on all platforms of interest, it's time to make it official
-by pushing it up to the distribution area on openmdao.org using the
-*push_release* script as follows:
+by pushing it up to the distribution area on ``openmdao.org`` using the
+``push_release`` script as follows:
::
push_relase <release_directory> http://openmdao.org
-where *release_directory* is the destination directory you supplied earlier
-when you called *make_release*. The *push_release* script takes the files
+where ``release_directory`` is the destination directory you supplied earlier
+when you called ``make_release``. The ``push_release`` script takes the files
in the release directory and places them in the proper locations on the
-server, i.e. the docs and the go-openmdao.py file go in the *downloads*
+server, i.e., the docs and the ``go-openmdao.py`` file go in the *downloads*
area and the distribution packages go in the *dists* area. The second
-argument to *push_release* can be the URL of a different server or even
+argument to ``push_release`` can be the URL of a different server or even
a local directory path if you need to debug or test the process outside
-of the production environment. This is actually what *test_release* does
+of the production environment. This is actually what ``test_release`` does
when you supply it with a release directory.
The last step is to update the repository on GitHub ...
View
8 docs/glossary.rst
@@ -275,13 +275,7 @@ Glossary
A Fortran subroutine for solving linear and nonlinear constrained or
unconstrained function minimization problems.
-
- **NOSA**
- NASA Open Source Agreement. A software license approved by the Open
- Source Initiative (:term:`OSI`). The National Aeronautics and Space
- Administration (NASA) releases some software under this license.
-
-
+
**nose**
A unittest extension offering automatic test suite discovery and easy test
authoring.
View
4 docs/licenses/index.rst
@@ -4,8 +4,8 @@
Licenses
========
-OpenMDAO is released under the NASA Open Source Agreement (:term:`NOSA`) Version 1.3. For a description of this
-license, see the NOSA Open Source Initiative (:term:`OSI`) license `page <http://www.opensource.org/licenses/nasa1.3.php>`_.
+OpenMDAO is being released under the Apache License, Version 2.0, which has been approved by the Open Source Initiative
+:term:`OSI`). The text of this license can be found `here <http://www.apache.org/licenses/LICENSE-2.0>`_.
The following table provides a list of the distributions that are currently being used by
the OpenMDAO framework as well as the version, type of license, and a link for obtaining
Please sign in to comment.
Something went wrong with that request. Please try again.