diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a35760fc9058ceba5a3d43fb5bbed792d16ead5f..82a6e5bccaf372f836df03b0868e93cb120ba1bf 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -63,7 +63,7 @@ deploy-doc: - chmod 700 ~/.ssh - ssh-keyscan -H dop288 > ~/.ssh/known_hosts script: - - scp -r htmldoc/* citt@dop288:LOFARBeam + - scp -r htmldoc/* citt@dop288:EveryBeam only: refs: - master diff --git a/Doxyfile.in b/Doxyfile.in index e259c77143a9ae87a56f9f5dfec6376457b8d4ed..f0456d21b49e92c240e1f22835fff769dc4cb8ac 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "LOFARBeam" +PROJECT_NAME = "EveryBeam" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version diff --git a/README.md b/README.md index a3afb6c0a3f052b1943eee2ee66b672981f37bf9..b78c17898758a05b194e5b0ac6fb55eb7497784e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# LOFAR beam library +# EveryBeam library -Stand alone version of the LOFAR station response library. +Stand alone version of the LOFAR station response library (LOFARBeam). This package provides an abstract interface to a selection of beam responses, and beamformed versions thereof. Currently implemented are: @@ -23,7 +23,7 @@ Installation is then typically done as: make make install -A `Dockerfile` to compile a working version of DPPP and LOFARBeam is included in the `test` directory. +A `Dockerfile` to compile a working version of DPPP and EveryBeam is included in the `test` directory. ## Usage with DPPP @@ -44,5 +44,8 @@ To simulate visibilities with a certain element model, use `DPPP DPPP.parset` wh See [docs/design.md](docs/design.md) for design considerations. +## Documentation +The `doxygen` documentation for EveryBeam can be found at https://www.astron.nl/citt/EveryBeam/ + ## Compatibility note This package has undergone the same branching process as [the DP3 package](https://github.com/lofar-astron/DP3): it is a continuation of the LOFAR beam library at svn.astron.nl/LOFAR, and was extracted from and branched off LOFAR Release 3.2. The LOFAR beam package will likely not be maintained in the ASTRON repository.