Writing the documentation

[Pietro-Colonna]

Hello, has anyone written/ is anyone planning to write documentation on the use of pycycle?

I need to use pycycle for my PhD, and since I just started working with it, I was thinking about writing reference documentation to make it easier for people to approach the tool. I wanted to know if anyone is already working on it.

On a similar note, I wonder if there are many users currently using pycycle. In that case, it might not be a bad idea to create a preferred communication channel to bring them all together, such as a Discord server or a subreddit. The ability to communicate would certainly make everyone's work faster and more productive.

[Kenneth-T-Moore]

Hey, Pietro. Unfortunately, the only documentation we have is practically a bare outline with very little content, and a folder example_cycles, which contains some example models. We definitely need some real doc pages, but haven't had the resources to do it.

Your idea about having a communication channel is a good one. We've created a github discussion board that might serve as a good starting point:

https://github.com/OpenMDAO/pyCycle/discussions

I know that it isn't as convenient for direct communication as discord, but we have been using it for Aviary and it has made it easier for users to communicate with the developers.

[flight-test-engineering]

Hello Pietro,
I am using pyCycle to create an engine deck for the CF34-10E. I am in the process of recording a few videos.
This is an amazing library and I would be happy to collaborate and write a few guides.

[beynelmilel02]

i need pyCycle doc.i build the doc but there is not any information about tool.

[flight-test-engineering]

Hi Everyone, there is AI generated pseudo-documentation, which is much better than nothing.
See this discussion: pyCycle Documentation Roadmap #94