Add docker automatic build based on Dockerfiles

.github/workflows/deploy_docker.yml

@@ -1,10 +1,9 @@
-name: Deploy docker (arm64v8)
+name: Build and Push dockers
 
 on:
   push:
     branches:
-      #- 'main'
-      - 'abc'
+      - 'main'
 
 jobs:
   docker:
@@ -14,7 +13,8 @@ jobs:
       contents: read
 
     steps:
-      - uses: actions/checkout@main
+      - name: Checkout code
+        uses: actions/checkout@v3
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -28,10 +28,34 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Build and push
+      - name: Build ubuntu image 
         uses: docker/build-push-action@v5
         with:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ${{ secrets.DOCKERHUB_USERNAME }}/owl-arm64v8:latest
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/owl:main
+
+      - name: Build debian image 
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./docker/Dockerfile.debian
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/owl:debian
+
+      - name: Build fedora image 
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./docker/Dockerfile.fedora
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/owl:fedora
+
+      - name: Build archlinux image 
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./docker/Dockerfile.archlinux
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/owl:archlinux

CONTRIBUTING.md

@@ -1,9 +1,34 @@
 # How to Contribute
 
 Owl is a large open source project, to guarantee quality of the software and sustainable development, we enforce the following rules in day-to-day research, development, and project management.
-
 Besides coding, there are many other ways you can contribute. Bug reporting, typo fix, asking/answering questions, and improvement of existing documents are all well welcome.
 
+## Owl Team 
+
+To achieve our mission, we are assembling an *Owl Team*. Anyone who can potentially give sufficient contributions recognized by the community can request to be a team member.
+A team member is expected to make several valuable and significant contributions to the project in both quality and quantity. 
+Typically a committer focuses on one specific aspect of the project and is a domain expert. 
+We hope but cannot guarantee that the team members can cover all aspects of the code base.
+
+
+Emphasis are put on the responsibility of each team member.
+Each one should take responsibility of certain aspects of the code base, e.g. a module or maintenance for a specific OS platform.
+Team members, together with their domain aspects and responsibilities, will be listed here and also on the [Owl website](https://ocaml.xyz/).
+
+For anyone who is willing to contribute, some good starting points could be:
+- Participate in discussion in issues, and help to fix them
+- Fix [documentations](https://ocaml.xyz/docs/), mainly by changing the `.mli` files in the source code, based on which the documentations are generated
+- Fix [tutorials](https://ocaml.xyz/tutorial/); the code could be not runnable, or the content could not display properly
+- Add more examples and tests
+- Fix issues listed in the [TODO list](https://github.com/orgs/owlbarn/projects/2/views/2)
+- Propose to fix/improve anything that interests you during using Owl
+- ... 
+
+**Current team member:**
+
+- [@jzstark](https://github.com/jzstark): Project leader. Manage overall architecture, roadmap，and tech vision. Community communication. Set research agenda.
+- [@ryanrhymes](https://github.com/ryanrhymes): Potential commercialization, business opportunity & funding seeking.
+
 
 ## Coding Style
 
@@ -86,22 +111,4 @@ By making a contribution to this project, I certify that:
     personal information I submit with it, including my sign-off) is
     maintained indefinitely and may be redistributed consistent with
     this project or the open source license(s) involved.
-```
-
-
-## Becoming A Team Member
-
-Owl Team is open and always welcomes new members to join. If you are enthusiastic about scientific computing and numerical algorithms, you can be one of us. As a team member, you need to be aware of the following things.
-
-- You will be included in the [owlbarn organisation](https://github.com/owlbarn).
-
-- You will have access to Team Channel on Slack and join the R&D discussion. Your opinions matter in Owl's future roadmap.
-
-- You need to be responsible for one aspect (or one or multiple related modules) in Owl and lead its development.
-
-- You need to review the pull requests related to the area you are specialised in.
-
-- We value persistence. Being a team member requires you actively get involved in maintaining Owl and contributing to its code base. The team membership becomes invalidated automatically if your contributions cease.
-
-- Team membership is considered after you have made some significant contributions to Owl's code base or its ecosystem. You can always drop [me]([email protected]) a line to discuss.
-
+```

README.md

@@ -3,11 +3,29 @@
 [![build](https://github.com/owlbarn/owl/actions/workflows/deploy_docker.yml/badge.svg)](https://github.com/owlbarn/owl/actions/workflows/deploy_docker.yml)
 [![build](https://github.com/owlbarn/owl/actions/workflows/os.yml/badge.svg)](https://github.com/owlbarn/owl/actions/workflows/os.yml)
 
-Owl is a dedicated system for scientific and engineering computing. The system is developed in OCaml and licensed under MIT. The project is originated by [Liang Wang](https://liang.ocaml.xyz) and currently led by [Jianxin Zhao](https://jianxin.ocaml.xyz). The history of the project is on the [Wikipedia](https://en.wikipedia.org/wiki/Owl_Scientific_Computing).
+Owl is a dedicated system for scientific and engineering computing. The system is developed in OCaml and licensed under MIT. The project is originated by [Liang Wang](https://liang.ocaml.xyz) and currently led by [Jianxin Zhao](https://jianxin.ocaml.xyz). The history of the project can be seen on the [Wikipedia](https://en.wikipedia.org/wiki/Owl_Scientific_Computing) page.
+
+## Functionalities 
+
+Owl provides a wide range of scientific computing functionalities: 
+
+- mathematical function, from the basic `log`, `sin` etc., to special functions such as the Beta and Gamma functions
+- integration; interpolation and extrapolation
+- statistics and probability; e.g. generation of random number and various distributions 
+- various computation on n-dimensional arrays (tensors), including advanced slicing and broadcasting 
+- linear algebra
+- ordinary differential equations 
+- discrete Fourier Transform algorithms for signal processing 
+- algorithmic differentiation, or automatic differentiation
+- various optimization algorithms
+- regression algorithms
+- deep neural network and natural language processing with the optional support of computation graph optimization
+- dataframe processing
+- visualization (with the help of external package `owl-plot`)
 
 ## Installation
 
-Please follow the [tutorial](https://ocaml.xyz/tutorial/chapters/introduction.html) about installing Owl. 
+Please follow the [tutorial](https://ocaml.xyz/tutorial/chapters/introduction.html) about installing Owl. You can also start by trying the [docker images](https://hub.docker.com/r/matrixanger/owl). 
 
 ## Mission
 
@@ -17,31 +35,24 @@ Owl is the de-facto scientific computing library in OCaml. Currently we aim to a
 The current code base is designed to be concise and self-contained. 
 We encourage anyone who would like to build up their own tools based on Owl to create new repositories in the [Owlbarn](https://github.com/owlbarn) organization. 
 
-## Owl Team 
+## Owl Code Structure 
+
+To help potential developers to understand the structure of Owl, here we briefly describe its overall design. More detailed description can be found in the [documentation](https://ocaml.xyz/docs/) and the Owl [books](https://ocaml.xyz/).
+
+![Owl architecture 1](examples/owl-structure1.svg)
 
-To achieve this mission, we are assembling an *Owl Team*. Anyone who can potentially give sufficient contributions recognized by the community can request to be a team member.
-A team member is expected to make several valuable and significant contributions to the project in both quality and quantity. 
-Typically a committer focuses on one specific aspect of the project and is a domain expert. 
-We hope but cannot guarantee that the team members can cover all aspects of the code base.
+Owl provides a basic data structure for modern numerical computing: n-dimensional array (Ndarray). It is based on the mathematics, linear algebra, and statistics functions, which are built on both OCaml and C functions and libraries. 
 
+![Owl architecture 2](examples/owl-structure2.svg)
 
-Emphasis are put on the responsibility of each team member.
-Each one should take responsibility of certain aspects of the code base, e.g. a module or maintenance for a specific OS platform.
-Team members, together with their domain aspects and responsibilities, will be listed here and also on the [Owl website](https://ocaml.xyz/).
+Sharing the same set of interface with Ndarray is the `base` system data architecture, which is implemented in pure OCaml. It is also based on modules that are implemented in OCaml. However, though it is sufficient for daily use for normal computing, the base version Ndarray does not implement some advanced functions as in the previous Owl version Ndarray, and its performance is understandably much slower.
 
-For anyone who is willing to contribute, some good starting points could be:
-- Participate in discussion in issues, and help to fix them
-- Fix [documentations](https://ocaml.xyz/docs/), mainly by changing the `.mli` files in the source code, based on which the documentations are generated
-- Fix [tutorials](https://ocaml.xyz/tutorial/); the code could be not runnable, or the content could not display properly
-- Add more examples and tests
-- Fix issues listed in the [TODO list](https://github.com/orgs/owlbarn/projects/2/views/2)
-- Propose to fix/improve anything that interests you during using Owl
-- ... 
+![Owl architecture 3](examples/owl-structure3.svg)
 
-**Current team member:**
+Besides these two types of Ndarray, another type is CGraph-Ndarray, which can be used to support symbolic style computing like TensorFlow v1. It facilitate building computation graph and computation optimization. 
+The CGraph-Ndarray can be built up by wrapping up either of the previous two types of Ndarray, which are used for actual execution of computing.
+All three types of Ndarray can be used to support advanced computing modules, including algorithmic differentiation, optimization, and neural networks.
 
-- [@jzstark](https://github.com/jzstark): Project leader. Manage overall architecture, roadmap，and tech vision. Community communication. Set research agenda.
-- [@ryanrhymes](https://github.com/ryanrhymes): Potential commercialization, business opportunity & funding seeking.
 
 ## Code of Contributing 
 
@@ -58,22 +69,3 @@ Please check the full [contributing rules](CONTRIBUTING.md) and [code of conduct
 ## Community 
 
 The Owl community is based on the [OCaml Discourse](https://discuss.ocaml.org/) and [Owl Slack channel](https://owl-dev-team.slack.com/).  All participants in the community are encouraged to provide support for new users within the project management infrastructure. Those seeking technical support should also recognize that all support activities within the project is voluntary and is therefore provided as and when time permits.
-
-
-## Owl Code Structure 
-
-To help potential developers to understand the structure of Owl, here we briefly describe its overall design. More detailed description can be found in the [documentation](https://ocaml.xyz/docs/) and the Owl [books](https://ocaml.xyz/).
-
-![Owl architecture 1](examples/owl-structure1.svg)
-
-Owl provides a basic data structure for modern numerical computing: n-dimensional array (Ndarray). It is based on the mathematics, linear algebra, and statistics functions, which are built on both OCaml and C functions and libraries. 
-
-![Owl architecture 2](examples/owl-structure2.svg)
-
-Sharing the same set of interface with Ndarray is the `base` system data architecture, which is implemented in pure OCaml. It is also based on modules that are implemented in OCaml. However, though it is sufficient for daily use for normal computing, the base version Ndarray does not implement some advanced functions as in the previous Owl version Ndarray, and its performance is understandably much slower.
-
-![Owl architecture 3](examples/owl-structure3.svg)
-
-Besides these two types of Ndarray, another type is CGraph-Ndarray, which can be used to support symbolic style computing like TensorFlow v1. It facilitate building computation graph and computation optimization. 
-The CGraph-Ndarray can be built up by wrapping up either of the previous two types of Ndarray, which are used for actual execution of computing.
-All three types of Ndarray can be used to support advanced computing modules, including algorithmic differentiation, optimization, and neural networks.

docker/Dockerfile.archlinux

@@ -8,7 +8,8 @@ FROM ocaml/opam:archlinux-ocaml-5.1
 
 ##################### PREREQUISITES ########################
 
-RUN sudo pacman -S --noconfirm base-devel wget zlib shapelib
+# RUN sudo pacman -S --noconfirm base-devel wget zlib shapelib
+RUN sudo pacman -Syu --noconfirm && sudo pacman -S --noconfirm base-devel wget zlib shapelib
 RUN sudo pacman -S --noconfirm lapack cblas lapacke openblas 
 RUN opam install -y dune ocaml-compiler-libs ctypes alcotest utop conf-openblas dune-configurator stdio npy