<commit_before>apolloall
==========

apolloall is a container for all of individual git repositories that make up the
actual project.  Currently these are:

  + `theaceae`_ : https://github.com/ApolloFramework/theaceae
      - Main goal of the Apollo Framework: A set of test cases for evaluating
        discretization schemes across a wide range of physics cases
  + `Camellia`_ : https://github.com/ApolloFramework/Camellia 
      - A Petrov-Galerkin toolkit used to evaluate the different methods
  + `Camellia2`_ : https://github.com/ApolloFramework/Camellia2 
      - A Petrov-Galerkin toolkit used to evaluate the different methods
  + `Trilinos`_ : https://github.com/ApolloFramework/Trilinos 
      - Mathematics library that provides much of the core infrastructure for
        Camellia
  + `spack`_ : https://github.com/ApolloFramework/spack 
      - A meta-build system for easily building the dependency tree for the
        project within a single system


The above links point to the Apollo project forks of the respective git repositories.


Installation
==========

To check out the repostory from the command line:

  + git clone https://github.com/ApolloFramework/apolloall apolloall
<commit_msg>Add install instructions to readme. These are a condinsed version of the text in Configuration.rst<commit_after>apolloall
==========

apolloall is a container for all of individual git repositories that make up the
actual project.  Currently these are:

  + `theaceae`_ : https://github.com/ApolloFramework/theaceae
      - Main goal of the Apollo Framework: A set of test cases for evaluating
        discretization schemes across a wide range of physics cases
  + `Camellia`_ : https://github.com/ApolloFramework/Camellia 
      - A Petrov-Galerkin toolkit used to evaluate the different methods
  + `Camellia2`_ : https://github.com/ApolloFramework/Camellia2 
      - A Petrov-Galerkin toolkit used to evaluate the different methods
  + `Trilinos`_ : https://github.com/ApolloFramework/Trilinos 
      - Mathematics library that provides much of the core infrastructure for
        Camellia
  + `spack`_ : https://github.com/ApolloFramework/spack 
      - A meta-build system for easily building the dependency tree for the
        project within a single system


The above links point to the Apollo project forks of the respective git repositories.


Installation
==========

To check out the repository from the command line::

      git clone https://github.com/ApolloFramework/apolloall apolloall


To get all of the repositories we need, type from within the apolloall 
directory::

      ./externalrepos.sh -a

The first time this is run, it will do a `git clone`, and upon successive
invocations it will perform a `git update`.  

Options are available to `clone or update` a single repository.  To see these
options::

      ./externalrepos.sh -h

In addition to checking out the Apollo forks of these repositories,
`externalrepos.sh` also adds remotes to the upstream repositories.  To see the
essential actions taken, `externalrepos.sh` can `Show` it's actions::

      ./externalrepos.sh -S

Once the external repositories are checked out, then configuration can occur by
sourcing the appropriate shell files::

      source share/apollo.sh   # Bash users
      source share/apollo.csh  # tcsh users

To tell spack to get the package information for apollo::

      cat $APOLLO_ROOT/share/repos.yaml >> ~/.spack/repos.yaml

To install Camellia and all it's dependencies::

      spack install camellia

The spack package has instructions to install several versions of Camellia. 
The command::

      spack install camellia@apollo

Downloads and installs the master branch of camellia in the `apolloall` repository. It is equivalent to the command::

      spack install camellia

Alternatively the apolloall `camellia2` can be installed using the command::

      spack install camellia@apollo2

Finally the master branch of camellia can be installed using the command::

      spack install camellia@nates_master

Todo::
  + Fix package.py for apollo branches of camellia
  + I need a better name for the master branch of camellia
  + Create a package installer for theaceae
  + Instructions on how to use spack diy to install a local version of Camellia
{'fraction_non_alphanumeric': 0.0648472125029158, 'fraction_numerical': 0.0013995801259622112, 'mean_word_length': 3.635675675675676, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4059159', 'n_tokens_mistral': 1229, 'n_tokens_neox': 1127, 'n_words': 502}