Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
es6
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Open-CLI

Occam's command line package management tool.

Contents

Introduction

The open command line tool provides similar functionality to npm, but for Occam packages. Published packages appear on the Open Mathematics website and can be utilised in Occam.

Installation

If you are an end user, you can install open via npm. Instructions for doing so, together with other relevant information, can be found in the 'How to contribute' section on the front page of the aforementioned Open Mathematics website.

If you would like to contribute or would simply like to have a look at the code, you can clone the repository with Git...

git clone https://github.com/jecs-imperial/occam-open-cli.git

...and then install the dependencies with npm from within the project's root directory:

npm install

Usage

This is slightly different from npm in that open is usually executed from the parent directory of a project rather than from within the project sub-directory itself. Projects might reside in a ~/Mathematics/ directory, for example, in which case you should initialise open in there:

open initialise

This will create a hidden .openrc file which you should never share. The reason is that if you log in to or register with the Open Mathematics site, your access token will be stored in this hidden file.

If you wish to publish the induction package, say, assuming that you have a sub-directory called induction for that package, run the following:

open publish induction

Actually you can in fact get away with publishing from within projects' sub-directories by running open publish in them, in which cases open will go up one directory in order to find the .openrc file and figure out the package name for itself.

Bear in mind that Occam does not as yet directly support packages. Therefore for now it is best to clone them, which you can again do with open. For example:

open clone natural-numbers

In these cases open will recover the underlying GitHub repository from the package's meta-data and clone the repository for you. If you just wanted the bare package and not the repository, the following would suffice:

open natural-numbers

Both Occam and the Open Mathematics site are works in progress, as indeed is open. The remainder of this readme file gives some of the current thinking on versioning and so forth that has yet to be implemented.

Versioning

Versioning is taken out of the user's hands in order to avoid problems. A package is defined as P=(V,Z) where V is the version and Z is a compressed file containing the files. Version numbers are bumped whenever packages are published, ideally according to the following rules:

  • Let P be a package, namely a project that is published or about to be published. Packages are published incrementally, thus P0,P1,...Pn.

  • Let V(P) be the version of a package P and let Vn be equivalent to V(Pn). Versions are sequences (M,m,p) where M is the major version number, m the minor version number and p the patch number.

  • Let ∑(P) be the signature of a package, yet to be defined, and let ∑n be equivalent to ∑(Pn).

  • The versions V0, V1,... Vn of any package P, where Vk=(M,n,p), are defined by the following formal rules:

    • V0 = (0,0,0)
    • if ∑k+1=∑k then Vk+1=(M,n,p+1)
    • if ∑k+1⊃∑k then Vk+1=(M,n+1,0)
    • if ∑k+1⊉∑k then Vk+1=(M+1,0,0)

Intuitively, if the signature doesn't change, the patch number is bumped; if the new signature encloses the old, the minor version number is bumped; otherwise the major version number is bumped. This is in line with other versioning systems such as semver. It is again worth stressing that the version is not defined by the user nor stored in a project meta file. It will be calculated according to the above rules whenever new packages are published, in order to avoid mistakes and deliberate oversights (the author in particular being often guilty of this).

Given V=(M,m,.) and V'=(M',m',.), a partial ordering ⩽ can be defined by the following rule:

  • if V⩽V' then either M<M' or M=M' and m⩽m'

Note that for the moment there is no concept of a signature, see below, thus only patch numbers are ever bumped with each new release.

Signatures

Roughly speaking, the signature of a package would be the union of the signatures of all the rules, axioms, definitions, theorems, etc that it contains. The signature of any of these elements would completely characterise it from the outside. If two rules shared identical premises and conclusion, for example, regardless of the details of their proofs, they would have the same signature. A precise definition is less than straightforward because grammars play a role in exactly how statements, which make up premises and conclusions, can be considered to be the same. Changing an element's label would also change its signature.

Contact

About

Occam's command line package management tool.

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.