Skip to content

Commit

Permalink
Add tifuun welcome page
Browse files Browse the repository at this point in the history
  • Loading branch information
maybeetree committed Jun 22, 2024
1 parent a884d90 commit ddba47e
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 5 deletions.
2 changes: 2 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Start reading at [Installing RAIMAD](pages/install.md)
or [browse the map of all pages](map.md).
Are you a TIFUUN collaborator?
Visit the [TIFUUN collaborator welcome page](pages/tifuun.md)!


<!--
Expand Down
12 changes: 7 additions & 5 deletions doc/pages/layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ You should do this because:
class Antenna(rai.Compo):
class Layers:
gnd = rai.Layer('Ground plane')
conductor = rai.Layer('Conductor layer for antenna's active element')
gnd = rai.Layer("Ground plane")
conductor = rai.Layer("Conductor layer for antenna's active element")
def _make(self):
...
Expand All @@ -116,14 +116,16 @@ class MySpectrometer(rai.Compo):
class Layers:
nbtin = rai.Layer(
'Niobium-titanium-nitride layer deposited by electrobeam'
"Niobium-titanium-nitride layer deposited by electrobeam"
)
ox = rai.Layer('Dielectric silicon oxide layer')
al = rai.Layer('Aluminium ground plane')
ox = rai.Layer("Dielectric silicon oxide layer")
al = rai.Layer("Aluminium ground plane")
def _make(self):
...
```

The tutorial ends here for now.
Once you've made some components with RAIMAD,
you might want to learn about [packaging](packaging.md).

12 changes: 12 additions & 0 deletions doc/pages/packaging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Packaging

Packaging your components allows others to easily use them.

> [ INFO ]
>
> Are you a TIFUUN collaborator?
> Instead of creating your own package,
> we recommend contributing to one of the two
> existing packages instead.
> Read more on the [TIFUUN collaborator welcome page](tifuun.md).
>
> If you're not a TIFUUN collaborator or if you have a good reason
> to make your own package, read on.
RAIMAD packages are just Python packages,
so if you already know how to make Python packages,
you have a good headstart.
Expand Down
5 changes: 5 additions & 0 deletions doc/pages/raidex-tifuun-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
> to read.
> Do you have a private github repo? Then go to the guide for
> [private packages](raidex-tifuun-private.md)
>
> Are your components part of the `rai_compos_pub` or `rai_compos_priv`
> packages? Then you do not need to do anything; those repos are already
> configured for RAIDEX.
> Check the README files for more info.
So, you've
[set up your package](packaging.md)
Expand Down
42 changes: 42 additions & 0 deletions doc/pages/tifuun.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# TIFUUN Collaborators: Welcome!

Are you a TIFUUN collaborator?
Nice to meet you!
I hope RAIMAD will become useful in your work.

## TIFUUN github organisation

Are you already part of the
[TIFUUN organisation on github](https://github.com/tifuun)?
If not, please ask someone to add you!
This is where all RAIMAD-related development happens.

### Public and Private repositories

Would you like to develop components for RAIMAD
and share them with others?
Then you can add your components
to one of the two existing repositories:
[rai_compos_pub](https://github.com/tifuun/rai_compos_pub)
or
[rai_compos_priv](https://github.com/tifuun/rai_compos_pub)
.

The `rai_compos_pub` repository is publicly available:
anyone in the world can read your code.
The `rai_compos_priv`, however, is only visible to
other TIFUUN collaborators.
You can choose which of the two access policies is more
appropriate for your work.

If you want, you can also [create and your package](packaging.md).
However, this is sadly a bit of a tedious process,
especially if you are not familiar with Python packaging.
So you can save yourself a lot of headache by instead
contributing to one of the existing repos!

> [WORKINPROGRESS]
>
> We are working on tools that simplify the packaging process,
> but these won't be done for a while.

0 comments on commit ddba47e

Please sign in to comment.