Repository files navigation

CAPE is software to improve Computational Aerosciences Productivity &Execution.

Here is a link to a recording of a NASA Advanced Modeling & Simulation seminarthat announced the release of CAPE 1.0.0

https://www.nas.nasa.gov/pubs/ams/2023/03-09-23.html

CAPE has two main purposes:

1. To execute and post-process three different Computational Fluid Dynamics(CFD) solvers:

1. Cart3D
2. FUN3D
3. OVERFLOW
4. Kestrel (CAPE 1.1+)

2. Create and use "datakits" a combination of database and toolkit. These aredata structures particularly well-suited to databases created fromaerosciences data.

This package has been used by NASA teams to create large databases (in someinstances including over 10,000 CFD solutions) for flight programs such asSpace Launch System.

The main benefit of using CAPE for CFD run matrices is having a single tool todo many of the steps:

• create separate folders for each CFD case,
• copy files and make any modifications such as setting flight conditionsin input files,
• submit jobs to high-performance computing scheduling system such as PBS,
• monitor the status of those jobs,
• create PDF reports of results from one or more solutions,
• extract data and conduct other post-processing,
• archive (and unarchive, if necessary) solution files.

This software is released under the NASA Open Source Agreement Version 1.3 (seeLICENSE.rst). While the software is freely available to everyone, userregistration isrequested by emailing the author(s).

A collection of tutorials and examples can be found at

https://github.com/nasa-ddalle/

Full documentation can be found at

https://nasa.github.io/cape-doc

The simplest method to install CAPE is to usepip:

$python3 -m pip install git+https://github.com/nasa/cape.git#egg=cape

$py -m pip install git+https://github.com/nasa/cape.git#egg=cape

Notes:

1. On Windows (where CAPE might be of limited use), replacepython3withpy
2. It's also possible to install from one of the provided.whl files.
3. In many cases, adding--user to the above command is appropriate;on systems where you are not a root/admin user, such is likelyrequired.
4. If installing a new version of CAPE where one might already be present,add the option--upgrade.

Notices

Copyright © 2022 United States Government as represented by the Administratorof the National Aeronautics and Space Administration. All Rights Reserved.

Disclaimers

No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OFANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITEDTO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANYIMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ORFREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERRORFREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THESUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE ANENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS,RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONSRESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCYDISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IFPRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."

Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THEUNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANYPRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANYLIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE,INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'SUSE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THEUNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANYPRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FORANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THISAGREEMENT.