Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OSCAR banner #3410

Merged
merged 16 commits into from
Feb 28, 2024
Merged

Update OSCAR banner #3410

merged 16 commits into from
Feb 28, 2024

Conversation

paemurru
Copy link
Contributor

@paemurru paemurru commented Feb 21, 2024

In today's OSCAR meeting it was decided to decide by Monday which banner to use. Use the corresponding reaction to vote.

😄 Original OSCAR banner
vote_1_current

 
 
 

🎉 Very slight change
vote_2_curved

 
 
 

🚀 Julia-style, letters have vertical bars like in the current OSCAR logo (according to the meeting, the current OSCAR logo might change soon)
vote_3_julia_mimic_oscar_logo

 
 
 

❤️ Julia-style, clean version with no vertical bars
vote_4_julia_clean

@wdecker
Copy link
Collaborator

wdecker commented Feb 21, 2024 via email

@wdecker
Copy link
Collaborator

wdecker commented Feb 21, 2024 via email

fingolfin
fingolfin previously approved these changes Feb 21, 2024
Copy link
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

fine by me

@fingolfin fingolfin added the backport 1.0.x Should be backported to the release 1.0 branch label Feb 21, 2024
@lgoettgens
Copy link
Member

Please adapt the example output in the README.md file as well.

@paemurru
Copy link
Contributor Author

Since we always call OSCAR from Julia, I thought perhaps it is nice to match the OSCAR banner style with Julia's, what do you think?
banner_figlet

@joschmitt
Copy link
Member

I would be in favour of option # 3, if this is a vote. (Or anything else that at least partially resembles the "actual" logo from the website.)

@thofma
Copy link
Collaborator

thofma commented Feb 22, 2024

I must have missed the discussion, where we decided that we want to update the banner.

Since other stakeholders might have an opinion, we can quickly discuss it tomorrow.

While it is possible to have Julia syntax highlighting in REPL (terminal
or command line) using for example OhMyREPL, the first-time user will
probably not have this.
Copy link

codecov bot commented Feb 22, 2024

Codecov Report

Merging #3410 (cff7950) into master (5d19430) will increase coverage by 0.01%.
The diff coverage is 0.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3410      +/-   ##
==========================================
+ Coverage   81.89%   81.90%   +0.01%     
==========================================
  Files         561      561              
  Lines       75125    75111      -14     
==========================================
  Hits        61523    61523              
+ Misses      13602    13588      -14     
Files Coverage Δ
src/Oscar.jl 72.30% <0.00%> (+12.81%) ⬆️

@paemurru
Copy link
Contributor Author

Added more similarity with the OSCAR logo from the website.
banner_4_actual_logo

@aaruni96 aaruni96 mentioned this pull request Feb 22, 2024
33 tasks
@aaruni96
Copy link
Member

While we are taking the Julia banner as inspiration, it might be a nice idea to also add a link to the Oscar documentation along the Oscar banner.

@fingolfin
Copy link
Member

I don't care much, but let me point out that one issue with the Julia banner is that it doesn't work well if the terminal width is below a certain threshold (there is even a PR for this: JuliaLang/julia#51811). While the same holds for our current banner but the threshold is much smaller.

Don't take this as an objection, just as something to be considered.

src/Oscar.jl Outdated
println()
println("Type: '?Oscar' for more information")
println("(c) 2019-2024 by The OSCAR Development Team")
println(raw" ___ ____ ____ _ _.__ ")
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't the first line also have the | if you want to match Julia? And no trailing whitespace?

Suggested change
println(raw" ___ ____ ____ _ _.__ ")
println(raw" ___ ____ ____ _ _.__ |")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, the first line in the Julia banner just consists of the underscore character! To match it, I have made that the first line in the OSCAR banner consists of only underscore characters

src/Oscar.jl Outdated Show resolved Hide resolved
src/Oscar.jl Outdated
/ | \/ ___| / ___| / \ | |_ \ | Type "?Oscar" for more information
| | | \_|_ \| | / . \ | |_) | | Manual: https://docs.oscar-system.org
| |_| |___) | |___ / /_\ \| |_ < |
\_|_/\____/ \____/_/ _ \_\_| \_\ | Version """ * $VERSION_NUMBER)
Copy link
Member

@aaruni96 aaruni96 Feb 22, 2024

Choose a reason for hiding this comment

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

You have to enclose version number in string

Suggested change
\_|_/\____/ \____/_/ _ \_\_| \_\ | Version """ * $VERSION_NUMBER)
\_|_/\____/ \____/_/ _ \_\_| \_\ | Version """ * "$VERSION_NUMBER")

@paemurru
Copy link
Contributor Author

Looks like this now
banner_5_link

README.md Outdated Show resolved Hide resolved
@joschmitt
Copy link
Member

If this an ASCII art design competition I want to chuck in:

  _____  _____   _____     _     _  ___
 / _|_ \/  ___\ / ____|   / \   | | _  \
| /   \ | (___ | /       / . \  | | _) |
| |   | \__|  \| |      / / \ \ | | _ <
| \___/ |___)  | \____ / / = \ \| |  \ \
 \__|__/\_____/ \_____/_/  =  \_\_|  |_|

It's one line higher (and a few characters wider), but I think the S looks better with the extra line.
Okay, back to work for me... :)

@paemurru
Copy link
Contributor Author

Together with the rest of the banner text, the design by @joschmitt does not fit in a 80-character width terminal, which is a big down-side

@joschmitt
Copy link
Member

Together with the rest of the banner text, the design by @joschmitt does not fit in a 80-character width terminal, which is a big down-side

Yeah, I think the "fine-print" can also come below the logo. But yes, if we want to go full julia-style this doesn't work.

@paemurru
Copy link
Contributor Author

Removed top row dot character as recommended by @lgoettgens
banner_6_dot

@JohnAAbbott
Copy link
Contributor

To my eyes the current (old) banner is the worst: all the newer proposals are better!
I understand the reason for wanting the vertical lines in the banner (to mimic those in the logo), but to my eyes they look like "something went wrong" in the ASCII art version. TBH, it is not that important to me.
Where do we vote?

@lgoettgens
Copy link
Member

Where do we vote?

@paemurru will create a poll in this thread.

@HereAround
Copy link
Member

Where do we vote?

@paemurru will create a poll in this thread.

Despite reading the corresponding message on slack, I am uncertain how the vote is supposed to work. So...

I like Julia-style, clean version with no vertical bars best.

Thank you for working on this!

(I agree with @JohnAAbbott. Also to my eyes, the vertical lines in the third banner look like "something went wrong" in the ASCII art version.)

@paemurru
Copy link
Contributor Author

@HereAround Thank you! I would not have noticed myself that the vertical lines look odd.

How to vote: at the end of the first post of this pull request, there is a button to add a reaction.
scrn1 b
To vote, put a reaction according to which banner you wish to vote for.
scrn2 b

@wdecker
Copy link
Collaborator

wdecker commented Feb 25, 2024 via email

@benlorenz benlorenz mentioned this pull request Feb 26, 2024
31 tasks
@Krastanov
Copy link

Just for reference, a similar question and a lot of banner-handling code is being discussed for julia itself: JuliaLang/julia#51811

In particular, the new StyledStrings standard library can be pretty helpful.

@paemurru
Copy link
Contributor Author

paemurru commented Feb 27, 2024

Increased spacing between O and S according to suggestion by @wdecker.

  ___   ____   ____    _    ____
 / _ \ / ___| / ___|  / \  |  _ \   |  Combining ANTIC, GAP, Polymake, Singular
| | | |\___ \| |     / _ \ | |_) |  |  Type "?Oscar" for more information
| |_| | ___) | |___ / ___ \|  _ <   |  Manual: https://docs.oscar-system.org
 \___/ |____/ \____/_/   \_\_| \_\  |  Version 1.1.0-DEV

Added a one-line banner for small terminals (width less than 79 characters)

OSCAR 1.1.0-DEV  https://docs.oscar-system.org  Type "?Oscar" for help

@fieker fieker merged commit f468cca into oscar-system:master Feb 28, 2024
23 checks passed
mjrodgers pushed a commit to mjrodgers/Oscar.jl that referenced this pull request Feb 28, 2024
* New banner

* Raw strings to avoid '\' being treated as escaping

* figlet style OSCAR banner, update README.md

* Remove README.md julia syntax color

While it is possible to have Julia syntax highlighting in REPL (terminal
or command line) using for example OhMyREPL, the first-time user will
probably not have this.

* More similarity to logo from website

* Triple quoted string, manual link, text to top row

Co-authored-by: Max Horn <[email protected]>

* Fix string, remove text from top line

* Remove dot from top row in README.md

Co-authored-by: Lars Göttgens <[email protected]>

* Remove dot from top row in Oscar.jl

* Banner without vertical bars inside the letters

* Increase distance between O and S

* Print one-line banner for small terminals

---------

Co-authored-by: Max Horn <[email protected]>
Co-authored-by: Lars Göttgens <[email protected]>
benlorenz pushed a commit that referenced this pull request Feb 28, 2024
---------

Co-authored-by: Max Horn <[email protected]>
Co-authored-by: Lars Göttgens <[email protected]>
(cherry picked from commit f468cca)
@aaruni96 aaruni96 removed the backport 1.0.x Should be backported to the release 1.0 branch label Feb 29, 2024
benlorenz added a commit that referenced this pull request Feb 29, 2024
- Add QQBar docs to the manual #3423
- do not show the OscarInterface banner #3422
- fix bugs in all_OD_infos #3419
- Ep/ Rename Spec to AffineScheme #3345 #3425
- Remove two mentions of Arb_jll #3431
- Tweak epimorphism_from_free_group #3430
- CI: re-enable nightly #3435
- support gen(G::GAPGroup, 0) #3332
- Align all_*_groups methods some more #3433
- Add all_perfect_groups #3434
- Add all_primitive_groups and all_transitive_groups variants taking a single int or int range #3404
- fix a docstring #3436
- Fixes multivariate division #3396
- Docu invariants tori #3428
- Improve docstrings for is_conjugate/is_conjugate_with_data. #3384
- Fix ambient_module(M::SubquoModule) #3448
- Bugfix for printing of affine schemes #3437
- Bugfix for bugfix for printing of affine schemes #3445
- Update OSCAR banner #3410
- Docu invariants lin. red. groups (Lakshmi Ramesh and Wolfram Decker) #3443
- add od_from_atlas_group, od_from_p_subgroup, and helpers #3444
- Unexport normalise #3453
- support group properties for character tables #3449
- add docstrings for acting_group and action_function #3432 (exports are used in new groups code for the book)
- Adjust to renaming of rank(A::FinGenAbGroup) to torsion_free_rank(A::FinGenAbGroup) #3457
- Ensure fp_group(G) transfers group attributes #3464
- Added comment on convention #3467
- Export weierstrass_chart_on_minimal_model and patch transform_to_weierstrass #3458
- Fix a doc signature #3466
- Grading + caching for affine algebra of torus invariants #3469
@paemurru paemurru deleted the EP/Banner branch April 4, 2024 17:47
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.