[ET Trac] #2538: Inclusion of kuibit

[Gabriele Bozzola]

#2538: Inclusion of kuibit

 Reporter: Gabriele Bozzola
   Status: open
Milestone: ET_2021_11
  Version: development version
     Type: enhancement
 Priority: major
Component: 

Comment (by Gabriele Bozzola):

After the call this morning, I took the following step:

* Update the CI/CD pipeline. Now, when a release is tagged on GitHub, the documentation is archived to [sbozzolo.github.io/kuibit/VERSION](http://sbozzolo.github.io/kuibit/VERSION). Hence, it will be always possible to refer to the documentation for a specific stable version. [sbozzolo.github.io/kuibit/](http://sbozzolo.github.io/kuibit/) will point to the documentation generated from master. This will be the latest stable. [sbozzolo.github.io/kuibit/dev](http://sbozzolo.github.io/kuibit/dev) will be the documentation from the next version.
* Tagged a new release, 1.3.0. Hopefully, things should be working as expected [now.](http://now.It) It is on PyPi.

If installed with pip, kuibit should bring all the dependencies with it EXCEPT:

* numba \(optially needed to compute mismatch between gravitational waves\) 
* pycbc, lalsuite \(optially needed to test mismatch between gravitational waves\) 
* mayavi

mayavi is used in some examples for 3D rendering. However, the project does not seem maintained anymore and it not really compatible with recent versions of Python/vtk. mayavi is a dependency in the next version kuibit, but this might change in the future.

The following is an idea for distributing kuibit with the upcoming release of the Einstein Toolkit. If GetComponent can checkout a specific commit/tag, it can be used to download the kuibit repo for version 1.3.0. The main advantage of this is that users would have immediately all the examples on their machine. The examples are scripts that can be used to make plots and analysis without writing any code. Therefore, I think that they would be very useful for beginners. Then, users should install kuibit 1.3.0 with `pip install --user kuibit==1.3.0`. We can optionally recommend users to add CACTUS/kuibit/examples/bin to their PATH, so that making some plots becomes very easy. When a new version of kuibit is released, users can update it with pip and update the examples checking out the corresponding tag \(if they wish to do so\). The link to the documentation will be [sbozzolo.github.io/kuibit/](http://sbozzolo.github.io/kuibit/VERSION)1.3.0

‌

--
Ticket URL: https://bitbucket.org/einsteintoolkit/tickets/issues/2538/inclusion-of-kuibit
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.einsteintoolkit.org/pipermail/trac/attachments/20211028/1740e4b8/attachment.html