Skip to content

Initialize documentation#18

Merged
andreab1997 merged 26 commits into
mainfrom
init-docs
May 27, 2022
Merged

Initialize documentation#18
andreab1997 merged 26 commits into
mainfrom
init-docs

Conversation

@alecandido
Copy link
Copy Markdown
Collaborator

No description provided.

@alecandido alecandido mentioned this pull request May 19, 2022
@andreab1997
Copy link
Copy Markdown
Contributor

We need LHAPDF so you can't remove ...

Yes, I know but, as usual, I have some problems with the LHAPDF installation so, since I don't need it while I write the docs, I removed it for the moment. I will add it again as soon as we need to merge (or if and when I will solve the problem).

Comment thread .vscode/settings.json Outdated
@@ -0,0 +1,3 @@
{
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add .vscode to .gitignore

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add to .gitignore and do git rm on this file

Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated

\begin{align}
\label{eq:ev}
F_2(x,Q^2) &= \sum_i^{n_f} C_i(x,Q^2) \otimes f_i(x,Q^2) \nonumber \\
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • let's go full eko notation: so represent flavor space by bold
  • I'd also rather suppress the x-es on the rhs - because they are not the x from the lhs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree but I believe that the meaning of this notation is that after the convolution you are left with the dependence on x. So what I can do is to write something like (C(Q) \otimes f(Q) )(x). What do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and regarding the flavor space, do you mean the n_f? or the PDFs (and the ekos) in flavor basis?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • flavor: suppress all flavor stuff: sum, i, nf
  • x: mmm, I'd rather have no x-es at all, if needs be suppress also on the left; what do you think @andreab1997 @alecandido ?

Copy link
Copy Markdown
Contributor

@andreab1997 andreab1997 May 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, for the moment I leave as they are.

Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread docs/source/theory/fktables.rst Outdated
Comment thread pyproject.toml Outdated
@andreab1997
Copy link
Copy Markdown
Contributor

@alecandido @felixhekhorn What else do we want to be in this docs?

@alecandido
Copy link
Copy Markdown
Collaborator Author

alecandido commented May 27, 2022

@alecandido @felixhekhorn What else do we want to be in this docs?

This PR is only to initialize the docs, if you believe is good enough we can even merge.
Please:

  • add the .readthedocs.yaml file (you can take it from eko)

@andreab1997
Copy link
Copy Markdown
Contributor

@alecandido @felixhekhorn What else do we want to be in this docs?

This PR is only to initialize the docs, if you believe is good enough we can even merge. Please:

  • add the .readthedocs.yaml file (you can take it from eko)

I believe we can merge, at this point this is even more that just an initialization of the docs. However, it seems that there is a problem with ipykernel (^6.13.0). I can remove it (since I don't believe we are actually using it) but it seems strange to me that it is causing problems because it is also in the EKO pyproject.toml

@felixhekhorn
Copy link
Copy Markdown
Contributor

I believe we can merge, at this point this is even more that just an initialization of the docs. However, it seems that there is a problem with ipykernel (^6.13.0). I can remove it (since I don't believe we are actually using it) but it seems strange to me that it is causing problems because it is also in the EKO pyproject.toml

yes, remove it - it is used for nbsphinx

@alecandido
Copy link
Copy Markdown
Collaborator Author

alecandido commented May 27, 2022

Have you regenerated the poetry.lock file? You do it with:

# barely generate the file
poetry lock
# update dependencies, compatible to what is written in `pyproject.toml`
poetry update

both of the commands will generate poetry.lock.

Consider that when installing, is mainly trying to use poetry.lock, looking at pyproject.toml just to check everything is alright.

@andreab1997
Copy link
Copy Markdown
Contributor

Have you regenerated the poetry.lock file? You do it with:

# barely generate the file
poetry lock
# update dependencies, compatible to what is written in `pyproject.toml`
poetry update

both of the commands will generate poetry.lock.

Consider that when installing, is mainly trying to use poetry.lock, looking at pyproject.toml just to check everything is alright.

No, I am doing it now

@andreab1997
Copy link
Copy Markdown
Contributor

Can I merge then?

@felixhekhorn
Copy link
Copy Markdown
Contributor

please wait a bit - I'm on it right now ...

@andreab1997
Copy link
Copy Markdown
Contributor

please wait a bit - I'm on it right now ...

Oh I am sorry, I thought you already had looked at it

@felixhekhorn
Copy link
Copy Markdown
Contributor

Ok - I did what I wanted to do ... as said this is just a beginning so, I'm even fine with merging ... and, actually, I didn't read carefully the SV page e.g. but I trust you @andreab1997 🙃

Comment thread docs/source/overview/Prerequisites.rst
@alecandido
Copy link
Copy Markdown
Collaborator Author

alecandido commented May 27, 2022

@andreab1997 fix the two things about files:

  • remove .vscode with git rm
  • make all file names lower case

and you can merge for me.

@andreab1997
Copy link
Copy Markdown
Contributor

Ok - I did what I wanted to do ... as said this is just a beginning so, I'm even fine with merging ... and, actually, I didn't read carefully the SV page e.g. but I trust you @andreab1997 🙃

Thank you for the fixes (and for the trust :) ). I am merging now

@andreab1997 andreab1997 merged commit 70bd270 into main May 27, 2022
@delete-merged-branch delete-merged-branch Bot deleted the init-docs branch May 27, 2022 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants