https://github.com/emmt/yfitsio
Yorick plug-in for reading/writing FITS files thanks to the CFITSIO library.
https://github.com/emmt/yfitsio
Last synced: 11 months ago
JSON representation
Yorick plug-in for reading/writing FITS files thanks to the CFITSIO library.
- Host: GitHub
- URL: https://github.com/emmt/yfitsio
- Owner: emmt
- License: other
- Created: 2015-10-07T10:46:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-01T20:12:50.000Z (over 7 years ago)
- Last Synced: 2025-06-08T18:03:59.049Z (12 months ago)
- Language: C
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: LICENSE.md
- Authors: AUTHORS
Awesome Lists containing this project
README
YFITSIO
=======
YFITSIO is a Yorick plug-in for reading/writing FITS files thanks to the
[CFITSIO library](http://heasarc.gsfc.nasa.gov/fitsio/fitsio.html). FITS
(for Flexible Image Transport System) is a file format mostly used in
astronomy. When complete, this plug-in will supersede the functionalities
implemented by `"fits.i"` in pure Yorick, in the mean time the prefix
`fitsio_` is used to avoid confusion with the `fits_` suffix used by the
routines defined by `"fits.i"`.
Installation
------------
In short, building and installing the plug-in can be as quick as:
````{.sh}
cd $BUILD_DIR
$SRC_DIR/configure
make
make install
````
where `$BUILD_DIR` is the build directory (at your convenience) and
`$SRC_DIR` is the source directory of the plug-in code. The build and
source directories can be the same in which case, call `./configure` to
configure for building.
If the plug-in has been properly installed, it is sufficient to use any
function of YFITSIO to automatically load the plug-in. You may force the
loading of the plug-in by something like:
````{.sh}
#include "fitsio.i"
````
or
````{.sh}
require, "fitsio.i";
````
in your code.
More detailled installation explanations are given below.
1. You must have Yorick and the CFITSIO library installed on your machine.
2. Unpack the plug-in code somewhere.
3. Configure for compilation. There are two possibilities:
For an **in-place build**, go to the source directory, say `$SRC_DIR`, of
the plug-in code and run the configuration script:
````{.sh}
cd $SRC_DIR
./configure
````
To see the configuration options, call:
````{.sh}
./configure --help
````
To compile in a **different build directory**, say `$BUILD_DIR`, create the
build directory, go to the build directory and run the configuration
script:
````{.sh}
mkdir -p $BUILD_DIR
cd $BUILD_DIR
$SRC_DIR/configure
````
where `$SRC_DIR` is the path to the source directory of the plug-in code.
To see the configuration options, call:
````{.sh}
$SRC_DIR/configure --help
````
4. Compile the code:
````{.sh}
make
````
4. Install the plug-in in Yorick directories:
````{.sh}
make install
````