Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scripts to package for Octave-Forge #1

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

kakila
Copy link

@kakila kakila commented Jul 11, 2017

Hi,

I have created scripts to transform the structure of the package into the one used in Octave-Forge.
I have also included a Makefile that allows to do a package that can be installed from the Octave prompt (not in windows)

pkg install ekfukf-<version>.tar.gz

Once this is done the package can be loaded and unloaded into octave using

pkg load ekfukf

pkg unload ekfukf

When the package is in a final form it can be submitted to Octave-Forge as an external package, when hosted there user will be able to do

pkg install -forge ekfukf

to download and install the latest release of the package.

The OF package needs the following files

  • INDEX: I create this automatically based on Contents.m
  • COPYING: I just rename LICENSE.txt
  • NEWS: I have added a placeholder here, but I probably do it automatically based on ReleaseNotes.txt
  • CITATION: I think this might be important for you. I just fill it in with the reference to the book, but please do tell me if you want other citation. If you have a bibtex object that would add extra value. The content of this file is shown when the user does citation ekfukf in the Octave prompt
  • DESCRIPTION: I created it manually base don README.md, but please let me know if you want changes.

If you have access to a linux machine and you have installed octave (at least 4.0, but recommended is 4.2.1 (latest stable release)) you can try the following:

  1. From the folder octave_pkg (in my version of the repository) run
    ./do_ekfukf_pkg.sh
    This will create a folder with the structure of an OF package, default is ekfukf_of
  2. Inside the created folder (cd ekfukf_of) run
    make install
    This will install the package in the octave search path (where exactly depend son your .octaverc, you can change the location using pkg prefix)
  3. Run octave and try, e.g.
    pkg load ekfukf
    help kf_loop
    pkg unload ekfukf

Let me know if you find anything you would like to change.

Regards,

@kakila kakila mentioned this pull request Jun 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant