Skip to content

Commit

Permalink
refactor: update README.md to include link to examples folder
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed Jun 17, 2024
1 parent faa4de8 commit 36298ad
Show file tree
Hide file tree
Showing 46 changed files with 725 additions and 24 deletions.
16 changes: 16 additions & 0 deletions examples/data_analysis_example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - data_analysis_example 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/deriv_example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - deriv_example 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/diff_example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - diff_example 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/dist_histogram/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - dist_histogram 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/fft_plot_example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - fft_plot_example 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/io_h5_dataset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - io_h5_dataset 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/io_h5_relax/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - io_h5_relax 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/iter_lazy_generation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - iter_lazy_generation 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/la_triplet01/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - la_triplet01 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_kmeans/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_kmeans 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_kmeans_plot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_kmeans_plot 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_knn_plot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_knn_plot 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_linreg01/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_linreg01 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_linreg02/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_linreg02 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_linreg_plot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_linreg_plot 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/ml_sentiment_analysis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - ml_sentiment_analysis 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
30 changes: 10 additions & 20 deletions examples/mpi_basic_example/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,16 @@
# MPI Basic example
# Example - mpi_basic_example 📘

This example shows how to use the basic MPI functions in VSL.
This example demonstrates the usage of the V Scientific Library for various purposes.

## Quickstart
## Instructions

- Compile the example with:
1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```bash
v -o mpi_basic_example -prod -cc mpirun main.v
```sh
v run main.v
```

- Run the example with:

```bash
$ mpirun -np 2 -H localhost:8 ./mpi_basic_example
Test MPI 01
Hello from rank 0
The world has 2 processes
Hello from rank 1
The world has 2 processes
ID: 0 - Assertion: true
ID: 0 - Assertion: true
ID: 1 - Assertion: true
ID: 1 - Assertion: true
```
Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/plot_annotated_pie_chart/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - plot_annotated_pie_chart 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/plot_bar/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - plot_bar 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/plot_basic_heatmap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - plot_basic_heatmap 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/plot_bubble_chart/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - plot_bubble_chart 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
16 changes: 16 additions & 0 deletions examples/plot_grouped_bar_chart/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Example - plot_grouped_bar_chart 📘

This example demonstrates the usage of the V Scientific Library for various purposes.

## Instructions

1. Ensure you have the V compiler installed. You can download it from [here](https://vlang.io).
2. Ensure you have the VSL installed. You can do it following the [installation guide](https://github.com/vlang/vsl?tab=readme-ov-file#-installation)!
3. Navigate to this directory.
4. Run the example using the following command:

```sh
v run main.v
```

Enjoy exploring the capabilities of the V Scientific Library! 😊
Loading

0 comments on commit 36298ad

Please sign in to comment.