GSoC: documentation #167

unkcpz · 2020-08-20T03:03:53Z

Change the doc theme same as kiwipy
add docstring to all public methods
add new examples
reorganize the section of the doc.

- adding new logo - using new theme same as kiwipy - reorganized the documentation structure

chrisjsewell · 2020-11-21T01:17:00Z

you can remove all the type/rtype in these docstrings, in favour of #180 😄

chrisjsewell · 2020-11-21T01:31:48Z

I also added sphinx-autobuild to tox 806f932

unkcpz · 2020-11-21T07:24:12Z

you can remove all the type/rtype in these docstrings

@chrisjsewell thanks! will do it.

also a good reminder, here is an unfinished PR. 😄

chrisjsewell · 2020-11-21T13:22:51Z

Haha yeh happy to help you finish this.
It's on my todo list to add documentation about the engine to aiida-core, so would save me work if I can just link to these docs 😝

chrisjsewell · 2021-01-05T14:46:46Z

Hey @unkcpz lets get this done and dusted 😀
Few conflicts to fix from #180, and just let me know if you need any help or when its ready for review cheers

chrisjsewell · 2021-01-05T23:58:53Z

actually I've copied it over to #190

chrisjsewell · 2021-01-05T14:49:49Z

docs/source/concepts.rst

+Process
+-------
+
+The probably most basic concept in plumpy is the process. A process is an asynchronously running component that is typically defined as a static, "long-running" part of the workflow.


Suggested change

The probably most basic concept in plumpy is the process. A process is an asynchronously running component that is typically defined as a static, "long-running" part of the workflow.

The most basic concept in plumpy is the process.

A process is an asynchronously running component that is typically defined as a static, "long-running" part of the workflow.

chrisjsewell · 2021-01-05T14:54:24Z

docs/source/concepts.rst

+Workchain
+---------
+
+`WorkChain` is `Process`, however, not only the `Process`.


Suggested change

`WorkChain` is `Process`, however, not only the `Process`.

A `WorkChain` is a sub-class of `Process`, with additional features for running a process as a set of discrete steps (also known as instructions).

chrisjsewell · 2021-01-05T14:56:17Z

docs/source/concepts.rst

+
+`WorkChain` is `Process`, however, not only the `Process`.
+
+A WorkChain is a series of instructions carried out with the ability to save state in between.


Suggested change

A WorkChain is a series of instructions carried out with the ability to save state in between.

A concrete `WorkChain` is created with a series of instructions to be carried out, and has the ability to save the state of the process after each instruction has completed.

chrisjsewell · 2021-01-05T14:58:25Z

docs/source/concepts.rst

+
+A WorkChain is a series of instructions carried out with the ability to save state in between.
+
+The `outline` can give a succinct summary of the logical steps that the workchain will perform.


Suggested change

The `outline` can give a succinct summary of the logical steps that the workchain will perform.

The set of instructions is defined in the `outline` method, which provides a succinct summary of the logical steps that the workchain will perform.

chrisjsewell · 2021-01-05T14:59:30Z

docs/source/concepts.rst

+A WorkChain is a series of instructions carried out with the ability to save state in between.
+
+The `outline` can give a succinct summary of the logical steps that the workchain will perform.
+WorkChain supporting using `If_` and `While_` to control the state flow of certain processes.


Suggested change

WorkChain supporting using `If_` and `While_` to control the state flow of certain processes.

WorkChains support the use of logical constructs such as `If_` and `While_` to control the state flow of certain processes.

chrisjsewell · 2021-01-05T14:59:58Z

docs/source/concepts.rst

+
+
+Controller
+__________


Suggested change

__________

----------

chrisjsewell · 2021-01-05T15:04:19Z

docs/source/concepts.rst

+
+Controller
+__________
+The controller control the process by sending and processing signals over RabbitMQ with the implementation of kiwipy.


Suggested change

The controller control the process by sending and processing signals over RabbitMQ with the implementation of kiwipy.

The `Controller` controls the process by sending and recieving signals from the `RabbitMQ <https://www.rabbitmq.com/>`__ message broker, using the Python interface implemented in `kiwipy <https://kiwipy.readthedocs.io/>`__.

chrisjsewell · 2021-01-05T15:07:10Z

docs/source/concepts.rst

+There are two types of implementation of controller in plumpy, the asynchronous one `RemoteProcessController` and synchronous
+one `RemoteProcessThreadController`. The difference of `RemoteProcessController` is that its methods are coroutines which are running without blocking other tasks.


Suggested change

There are two types of implementation of controller in plumpy, the asynchronous one `RemoteProcessController` and synchronous

one `RemoteProcessThreadController`. The difference of `RemoteProcessController` is that its methods are coroutines which are running without blocking other tasks.

There are two types of `Controller` implementation in plumpy; the synchronous (blocking) `RemoteProcessThreadController` and asynchronous (non-blocking) `RemoteProcessController`.

unkcpz · 2021-01-06T07:09:38Z

@chrisjsewell thanks! I plan to come back to make this done after #180 merged.
Well... since you copy this, what is the correct way to continue this PR?

chrisjsewell · 2021-01-11T13:56:46Z

Well... since you copy this, what is the correct way to continue this PR?

Well as I was reviewing, I realised there was a lot to change/add lol. So yeh I would say, once I have finished it (hopefully today), to check that you are happy I have included everything from this PR in #190, then close it

chrisjsewell · 2021-02-02T15:04:18Z

I will close this for now, since it has been essentially superseded by #190 and #192

unkcpz added 2 commits August 20, 2020 10:56

add docstring to public methods and refine DOC

0f57b8b

refactoring the documentation

196d3ad

- adding new logo - using new theme same as kiwipy - reorganized the documentation structure

unkcpz marked this pull request as draft August 20, 2020 03:04

logo change

d62421e

chrisjsewell suggested changes Jan 5, 2021

View reviewed changes

chrisjsewell mentioned this pull request Jan 11, 2021

👌 IMPROVE: remove RUNNING from allowed states of resume #192

Merged

chrisjsewell closed this Feb 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GSoC: documentation #167

GSoC: documentation #167

unkcpz commented Aug 20, 2020

chrisjsewell commented Nov 21, 2020

chrisjsewell commented Nov 21, 2020

unkcpz commented Nov 21, 2020

chrisjsewell commented Nov 21, 2020

chrisjsewell commented Jan 5, 2021

chrisjsewell commented Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

chrisjsewell Jan 5, 2021

unkcpz commented Jan 6, 2021

chrisjsewell commented Jan 11, 2021

chrisjsewell commented Feb 2, 2021

	The probably most basic concept in plumpy is the process. A process is an asynchronously running component that is typically defined as a static, "long-running" part of the workflow.
	The most basic concept in plumpy is the process.
	A process is an asynchronously running component that is typically defined as a static, "long-running" part of the workflow.

	`WorkChain` is `Process`, however, not only the `Process`.
	A `WorkChain` is a sub-class of `Process`, with additional features for running a process as a set of discrete steps (also known as instructions).


		`WorkChain` is `Process`, however, not only the `Process`.

		A WorkChain is a series of instructions carried out with the ability to save state in between.

	A WorkChain is a series of instructions carried out with the ability to save state in between.
	A concrete `WorkChain` is created with a series of instructions to be carried out, and has the ability to save the state of the process after each instruction has completed.


		A WorkChain is a series of instructions carried out with the ability to save state in between.

		The `outline` can give a succinct summary of the logical steps that the workchain will perform.

	The `outline` can give a succinct summary of the logical steps that the workchain will perform.
	The set of instructions is defined in the `outline` method, which provides a succinct summary of the logical steps that the workchain will perform.

	WorkChain supporting using `If_` and `While_` to control the state flow of certain processes.
	WorkChains support the use of logical constructs such as `If_` and `While_` to control the state flow of certain processes.

	The controller control the process by sending and processing signals over RabbitMQ with the implementation of kiwipy.
	The `Controller` controls the process by sending and recieving signals from the `RabbitMQ <https://www.rabbitmq.com/>`__ message broker, using the Python interface implemented in `kiwipy <https://kiwipy.readthedocs.io/>`__.

		There are two types of implementation of controller in plumpy, the asynchronous one `RemoteProcessController` and synchronous
		one `RemoteProcessThreadController`. The difference of `RemoteProcessController` is that its methods are coroutines which are running without blocking other tasks.



		Controller
		__________

GSoC: documentation #167

GSoC: documentation #167

Conversation

unkcpz commented Aug 20, 2020

chrisjsewell commented Nov 21, 2020

chrisjsewell commented Nov 21, 2020

unkcpz commented Nov 21, 2020

chrisjsewell commented Nov 21, 2020

chrisjsewell commented Jan 5, 2021

chrisjsewell commented Jan 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unkcpz commented Jan 6, 2021

chrisjsewell commented Jan 11, 2021

chrisjsewell commented Feb 2, 2021