{"id":16806218,"url":"https://github.com/pkgw/miriad-python","last_synced_at":"2025-04-11T00:50:24.493Z","repository":{"id":1047737,"uuid":"879109","full_name":"pkgw/miriad-python","owner":"pkgw","description":"Clean Python bindings to the MIRIAD radio astronomy package","archived":false,"fork":false,"pushed_at":"2015-10-06T22:11:34.000Z","size":1065,"stargazers_count":10,"open_issues_count":6,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T21:38:45.246Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.cfa.harvard.edu/~pwilliam/miriad-python/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pkgw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-09-01T16:58:44.000Z","updated_at":"2024-08-26T08:57:04.000Z","dependencies_parsed_at":"2022-07-18T05:21:35.749Z","dependency_job_id":null,"html_url":"https://github.com/pkgw/miriad-python","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fmiriad-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fmiriad-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fmiriad-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pkgw%2Fmiriad-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pkgw","download_url":"https://codeload.github.com/pkgw/miriad-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322609,"owners_count":21084336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T09:50:25.807Z","updated_at":"2025-04-11T00:50:24.471Z","avatar_url":"https://github.com/pkgw.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"miriad-python 1.2.4\n===================\n\nmiriad-python is a bridge between the MIRIAD radio analysis package and\nthe Python programming language. It allows you to:\n\n* read and write MIRIAD datasets in Python,\n* execute MIRIAD tasks from Python, and\n* write MIRIAD tasks in Python.\n\nThis file contains detailed installation instructions. For all other\nmatters, the best resource is the miriad-python website:\n\n  https://www.cfa.harvard.edu/~pwilliam/miriad-python/\n\nThe website includes up-to-date contact information for the\ndevelopers, who will be happy to assist you if you have trouble\ninstalling or using miriad-python.\n\nIf you use miriad-python in academic research, please cite Williams\net al., 2012 PASP 124 624 (doi:10.1086/666604) in any resulting\npublications.\n\n\nInstallation Instructions\n=========================\n\nThe basic installation recipe is the standard Linux one:\n\n    ./configure --prefix=PREFIX --with-miriad=MIRIAD_LOCATION\n    make \u0026\u0026 make install\n\nwhere `PREFIX` and `MIRIAD_LOCATION` are replaced with appropriate\nvalues. Many more details are below.\n\nRequirements\n------------\n\nThe following packages are required to install miriad-python:\n\n * Python version 2.5 or greater\n * NumPy version 1.2 or greater\n * Matching C and Fortran-77 compilers (we use gcc and gfortran 4.8)\n * A recent working installation of CARMA MIRIAD. More on this below.\n\nIf you're using a Mac, the best way to get an installation of Python with\nNumpy is to install the latest version of the \"Anaconda\" Python distribution,\nfound here:\n\n  http://www.continuum.io/downloads\n\nIf you install this Python distribution, make sure to start a new terminal\nthat picks up the custom Anaconda `python` program before proceeding. You\nshould also make sure to install miriad-python into the same location as\nAnaconda so that it can find the miriad-python modules automatically.\n\nThere are multiple divergent MIRIAD codebases, and multiple ways to build\nthem. Miriad-python must be built against the CARMA version of MIRIAD. We\nattempt to support a variety of installations, but the most reliable setup is\na recent installation based on the \"new-style\" autotools build system.\n\nCARMA MIRIAD's homepage is\n\n  http://carma.astro.umd.edu/wiki/index.php/Miriad\n\nThe binary packages distributed at that site are built with the \"old style\"\nsystem. Miriad-python aims to be compatible with these packages, but there\nare some issues with the way that they're built that can prevent things\nfrom working.\n\nIf you use a Mac and the CARMA binary packages don't work for you, we\nsuggest the MIRIAD MacPort:\n\n  https://www.cfa.harvard.edu/~pwilliam/miriad-macport/\n\nIf you don't use a Mac, it's not too hard to build CARMA MIRIAD with\nthe \"new-style\" (autotools) build system yourself. It is easiest to\nstart with the most recent source code package used by the MacPort:\n\n  https://www.cfa.harvard.edu/~pwilliam/miriad-macport/miriad-latest.tar.gz\n\nFor the very latest MIRIAD source code, you may find it useful to\naccess Peter Williams' GitHub mirror of the CARMA MIRIAD source\ntree.\n\n  https://github.com/pkgw/carma-miriad\n\nThis option presents the same autotools-related challenges as those\nrelating to Git checkouts of this package -- see the following\nsection.\n\nThe miriad-python build configuration step should give you an error if\nit encounters an install of MIRIAD that it can’t handle.\n\nPre-Configuration\n-----------------\n\nIf the file `configure` exists in the same directory as this file, you\nmay skip this section. And you want to skip this section if you\npossibly can.\n\nIf you're still here, you've probably downloaded miriad-python from\nthe Git repository, and the GNU \"autotools\" build system needs to be\nset up. Sometimes the setup process works like a charm; other times\nthings go down in flames and no one except a deep autotools expert can\nfigure out how to fix things.\n\nSo:\n\n  * If the `configure` script exists and you're not *very comfortable*\n    with what you're doing, skip this step!\n\n  * If the following pre-configuration steps give you any problems,\n    go to the website and download an official release archive, for\n    which this step is not necessary. If the official releases are\n    too old for your purposes, ask for a new one to be made.\n\n  * The autotools have one advantage in that they're widely used.\n    If you absolutely must fight through them, contact your local\n    system administrator or Linux expert. He or she can probably\n    help without needing to know any specifics about miriad-python.\n\nIf you're still still here, the setup process is simple in\ntheory. In this directory, run:\n\n    ACLOCAL=\"aclocal -I build-aux\" autoreconf -fi\n\n(This assumes you use a Bourne shell. If you don't know what that is\nor if you are, you should probably stick with official release\narchives.)\n\nIf these steps succeed, that's good. But these steps may succeed and\nstill lead to bizarre failures farther downstream in the build\nprocess. If anything happens that you can't figure out, it is *highly\nrecommended* that you try out an official release to see if that\nsidesteps the problem.\n\nConfiguration\n-------------\n\nThe first real step to installation is to configure the build. The\n`configure` program will check for a variety of features of your\ncomputer and report and error if anything is amiss. You must give\n`configure` two pieces of information:\n\n  * The \"prefix\" where miriad-python files will be installed.  The\n    default is `/usr/local`. The main miriad-python modules will land\n    in a directory named something like\n    `PREFIX/lib/python2.6/site-modules/`\n\n  * The location where your MIRIAD installation is found. There is\n    no default.\n\nThis is all accomplished by running the `configure` script like so:\n\n    ./configure --prefix=PREFIX --with-miriad=MIRPATH\n\nHere, MIRPATH is where MIRIAD has been installed. If you use a \"new-style\"\ninstallation, the following files should exist:\n`MIRPATH/include/miriad-c/miriad.h` and `MIRPATH/lib/libmir.EXT`, where `EXT`\nis `so` on Linux machines and `dylib` on Macs. If you're using a CARMA\nprecompiled distribution, the file `MIRPATH/src/inc/maxdim.h` should exist.\n\nIf you believe that you're specifying the correct --with-miriad\nargument and the `configure` checks are still failing, you can peruse\nthe file `config.log`, created by `configure`, for the particular\nerror that led the tool to fail. Sometimes unrelated problems can show\nup in this phase of the configuration process. If you still have\ntrouble, consult your local system administrator (with complete\ncontextual information) or the miriad-python developers.\n\nFor thorough but generic instructions on running the `configure`\nprogram, see\n\n  http://git.savannah.gnu.org/cgit/automake.git/tree/INSTALL\n\nCompilation\n-----------\n\nJust run `make`. If the configuration step completes successfully,\ncompilation should always succeed. If it doesn't, these generic\ninstructions are unable to help you.\n\nInstallation\n------------\n\nIf the compilation step succeeds, you can install. Run `make install`\nor `sudo make install` or `su -c 'make install'` as appropriate.\n\nVerification\n------------\n\nIn order to use miriad-python in your programs, your Python\ninterpreter must be able to find the miriad-python modules. If you\nconfigure miriad-python with a prefix matching that of your Python\ninterpreter, this should happen automatically. Otherwise, you may need\nto use the `$PYTHONPATH` environment variable. The directory that must\nbe searched is\n\n    PREFIX/lib/python2.6/site-packages\n\nwith two important caveats: firstly, replace the `2.6` with the\nappropriate version of your Python interpreter; secondly, if the\ndirectory\n\n    PREFIX/lib64/python2.6/site-packages\n\nexists, it must be added to the Python search path as well.\n\nTo superficially check that everything is accessible to the Python\ninterpreter, you can run\n\n    python -c \"import mirtask, mirexec, miriad\"\n\nIf no errors are reported, things are working.\n\nSome example programs are included in the examples/ directory. They\nrequire real input datasets to operate, but if you have some data\non-hand you can try them out. Each program is contains extensive\ninternal documentation. See also examples/README.\n\n\nBug Reports\n===========\n\nWe use the GitHub issue tracker for handling bug reports. See\n\n  https://github.com/pkgw/miriad-python/issues\n\n\nwcslib headers\n==============\n\n(This section documents an error that may be reported by the `configure`\nscript in certain conditions.)\n\nFirst of all, sorry for the terse error message produced by the\n`configure` program -- the tools we use make it really hard to produce\nhelpful, descriptive output at that point.\n\nIf you encounter this error, your installation of Miriad is not recent\nenough to contain certain files needed to compile miriad-python\nsuccessfully. Installations of Miriad with source code more recent\nthan January 3, 2012 should work. (Version numbers aren't very helpful\nin this case because Miriad releases are very infrequent.) The\nparticular error is a lack of private wcslib headers. Consult your\nlocal Miriad-installation guru for more help if you're not sure how to\nreact to this situation.\n\n\nbughandler_c\n============\n\n(This section documents an error that may be reported by the `configure`\nscript in certain conditions.)\n\nFirst of all, sorry for the terse error message produced by the\n`configure` program -- the tools we use make it really hard to produce\nhelpful, descriptive output at that point.\n\nThe source of this error is that your installation of Miriad is not\nrecent enough to contain certain hooks that are necessary for reliable\noperation of miriad-python. Installations of Miriad with source code\nmore recent than February 13, 2009 should work. (Version numbers\naren't very helpful in this case because Miriad releases are very\ninfrequent.) The particular error is a lack of the bughandler_c\nfunction, which should be found in the libmir library. Consult your\nlocal Miriad-installation guru for more help if you're not sure how to\nreact to this situation.\n\n\nf2py\n====\n\n(This section documents an error that may be reported by the `configure`\nscript in certain conditions.)\n\nFirst of all, sorry for the terse error message produced by the\n`configure` program -- the tools we use make it really hard to produce\nhelpful, descriptive output at that point.\n\nThe source of this error is that your system does not have the `f2py`\nprogram available. This program is usually distributed with the Numpy\npackage for numerical work in Python. If Numpy isn't available at all,\nyou need to install it. You may also need to install additional packages\nto get the f2py program in particular. On most OSes, both pieces are\navailable as a prebuilt binary package that should be easy to install.\nHere are the package names for some common Linux distributions:\n\n      Fedora: numpy, numpy-f2py\n      Ubuntu: python-numpy\n    OpenSuSE: python-numpy\n\nIf Numpy isn't available as a prebuilt binary package, you'll need to install\nit manually, instructions for which are beyond the scope of this document. See\nhttp://numpy.scipy.org or http://www.continuum.io/downloads.\n\n\nContact Information\n===================\n\nCheck the miriad-python website for up-to-date information. At the\ntime of release, the best contact person is Peter Williams,\npwilliams@cfa.harvard.edu . For bug reports, use the issue\ntracker on the miriad-python GitHub page:\n\n  https://github.com/pkgw/miriad-python/issues\n\n\nCopyright Notice\n================\n\nCopyright 2009-2013 Peter Williams\n\nThis file is free documentation; the copyright holder gives unlimited\npermission to copy, distribute, and modify it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Fmiriad-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpkgw%2Fmiriad-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpkgw%2Fmiriad-python/lists"}