Setting up CDA writes and cwms-python on T7s

Important

This is a living document and are subject to change.  Last updated:  

Install local CDA instance

 https://github.com/USACE/cwms-data-api/wiki/Installing-into-Tomcat

Setup Writing Data to CDA

Generate API KEY

  1. Goto the following URL for you local instance of CDA where xxx is your district code.
    1. https://wm.XXX.ds.usace.army.mil:8243/CWMSLogin/login
    2. If you get a “HTTP Status 404” error when trying to access that page then you need to Submit a General Request ticket to the G6 "Unix Web Server Support" Team in the body of the ticket write.
    3. A agreement will appear. Click accept. An output will show up with your user and the CWMS user roles assigned to your account. In order to write data the CWMS Users role is needed. 
  2. in server admin make sure you web user has the following permissions
    •  
  3. Goto you CDA swagger page
  4. Goto the Authorization endpoint and open the POST function
  5. Click “Try it out”
  6. In the example values dictionary enter your UPASSID. Or the UPASSID for the ID you want to create a key for.
  7. Enter a key-name. This is a descriptor and can be anything that you can remember
  8. For api-key you can leave this as ‘string’. The function will create an api key for you
  9. Expires enter a date in the future. You will need to update your api key before the expires date
  10. After those values have been entered click Execute.
  11. Under the 201 Created response a API key should be displayed. Save this apikey to be used to write data using CDA. 
  12. You can use your api key in cwms-python or using CDA. When using the apikey it needs to be prefix with the word ‘apikey ’ (without the single quotes and it does need a space between the word apikey and your actual apikey). 
    1. NOTE: If you are storing your API in a file to use in a script we recommend storing it without the apikey prefix and then adding the prefix in your script itself. For steps on how to do this please follow the steps listed under "5" in the portion "Using CDA and cwms-python Server side" below.

Using CDA and cwms-python Server side. 

  1. use new install python 3.9.18 version /wm/wmsoft/python/v3.9.18-Solaris11.4.65.157
  2. connection for both cwbi-test and your local copy of CDA in python require access to DOD root certificates.
  3. Those certificates have been copied to the /wm/wmsoft/certs folder.
  4. To allow python/request package to access them In your .bashrc file enter the following
    1. export REQUESTS_CA_BUNDLE=/wm/wmsoft/certs/cacert.pem
  5. to store and use your apikey to write data in a python script do the following
    1. create a folder .cwms in the /wm/xxx/xxcwpaxx folder that has 700 permissions.
    2. In the folder create a file cda_api_key that has 700 permissions
    3. In the file add your API_KEY to a single line.
    4. Can either access the api key by grabbing and storing in a environment variable in your .bashrc file
    5. Or you can use the following code in your python script
      • with open(os.environ["CWMS_HOME"] + "/.cwms/cda_api_key", "r") as f:
      • APIKEY = 'apikey ' + f.readline().strip()
    6. I would also suggest adding the following to you .bashrc file
    7. export CDA_API_ROOT=https://wm.XXX.ds.usace.army.mil:8243/XXX-data/
    8. then in your python scripts you can access it using
    9. APIROOT = os.environ['CDA_API_ROOT']
  6. Install cwms-python
    1. Run ./wm/wmsoft/python/v3.9.18-Solaris11.4.65.157/bin/pip install cwms-python
  7. update symlink
    1. update your symlink in /wm/localsoft/  to python3 to reference the new version of python.
  8. to update to a new version of cwms-python
    1. Run ./wm/wmsoft/python/v3.9.18-Solaris11.4.65.157/bin/pip install -U cwms-python

Using cwms-python on workstation

       Setup Using Anacaonda (no longer supported by USACE)

  1. for use of cwms-python on your workstation follow the following steps in the cwms-python_workstation_setup.docx located in the following teams folder 2024 Data Workshop.

      Setup using a portable python package

  1. Follow the following steps to setup a portably python environment.  Install Portable Python with cwms.docx with files located in the following folder.  python install.  Start of step B to just use the already created portable python environment.  If you want to create your own start with step A.
  2. Tutorials for cwms-python can be found in the github repo through the following link.  https://github.com/HydrologicEngineeringCenter/cwms-python/tree/main/examples