Skip to content

Commit

Permalink
Merge pull request #111 from helenkirk/update_docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
sfabbro authored Jun 28, 2024
2 parents e92021b + f7c6ab3 commit 0f84f21
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 20 deletions.
30 changes: 30 additions & 0 deletions docs/general/ALMA_Desktop/casa_containers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# General notes on CASA containers

This page contains a compilation of useful notes, etc, on various CASA containers.

## Astroquery / astropy

The [astroquery tool](https://astroquery.readthedocs.io/en/latest/) is presently only installed on the very latest CASA containers (>6.6), but will be installed in earlier versions as time permits. To use astroquery from an appropriate CASA container, type the following to initiate an astroquery-compatible version of python:
`/opt/casa/bin/python3`
As per the [astroquery documentation](https://astroquery.readthedocs.io/en/latest/), the tool can then be used on the command line within the python environment. For example, the following sequence of commands
`from astroquery.simbad import Simbad`
`result_table = Simbad.query_object("m1")`
`result_table.pprint()`
yield a one-line table listing some basic information about M1.

## Analysis Utilities
The [analysisUtils package](https://casaguides.nrao.edu/index.php/Analysis_Utilities) package is pre-installed on every CASA container, and is ready to use. You may need to type
`import analysisUtils as au`
to load it.

## UVMultiFit
The [UVMultiFit](https://github.com/onsala-space-observatory/UVMultiFit/blob/master/INSTALL.md) package is presently installed and working for all CASA 5.X versions except 5.8. To load the UVMultiFit package, initiate casa and then type
`from NordicARC import uvmultifit as uvm`

## Known Container Bugs
CASA versions 6.5.0 to 6.5.2 initially launch with some display errors in the logger window. Exiting casa (but not the container) and re-starting casa fixes the issue, i.e.,
`casa`
`exit`
`casa`


19 changes: 0 additions & 19 deletions docs/general/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ nav:
- Introduction and Access:
- complete/index.md
- General User Documentation:
- general/index.md
- New User Documentation:
- general/NewUser/Overview.md
- Login: general/NewUser/Login.md
Expand Down Expand Up @@ -119,4 +118,5 @@ nav:
- Downloading from the ALMA archive (browser): general/ALMA_Desktop/archive_download
- Downloading from the ALMA archive (script): general/ALMA_Desktop/archive_script_download
- Example of reducing image data: general/ALMA_Desktop/typical_reduction
- Notes on CASA Containers (features, known bugs, etc): general/ALMA_Desktop/casa_containers
- FAQ: complete/faq.md

0 comments on commit 0f84f21

Please sign in to comment.