Support for Apple Silicon (macOS on ARM) #7175

JosephRedfern · 2020-12-09T17:29:40Z

Apologies if this has already been discussed -- I have searched on both GitHub issues and Discourse but may have missed it.

Are there plans to provide macOS builds targeting Apple Silicon/M1/ARM64? What (if any) are the barriers to such builds being released, and is there anything that can be done to help with this?

JabRef appears functional under Rosetta 2, but native release would be optimal for both performance and efficiency. Is this a matter of bundling a JRE that doesn't rely on Rosetta 2?

Thanks,
Joe

Siedlerchr · 2020-12-09T18:52:22Z

Thanks for the question, it has not yet been discussed. I agree that this would be a nice thing to have.

JabRef depends both on the JDK version and javafx (openfjx)
The JDK environment seems to be already available for mac arm already. At least some experimental builds.
https://openjdk.java.net/jeps/391
The other thing is OpenJFX
https://bugs.openjdk.java.net/browse/JDK-8257222
To summarize, not yet possible, but they are working on it, unfortunately not yet a release/version planned.
Best is to keep an eye on the Javafx issue.

When all those issues are fixed, you should be able to compile JabRef yourself and run it natively.

Siedlerchr · 2021-03-20T16:55:31Z

There recently has been some work to build the javafx media libs and webkit libs for Apple Silicon, so it might be read with the next openjfx release.

astroboylrx · 2022-03-17T16:17:17Z

Any update on this issue? Thanks in advance

Siedlerchr · 2022-03-17T16:37:32Z

Yes it should be working now, but I am unsure if it needs to be built in a special way. You probably need to build JabRef from code on M1. I am not sure if the jpackage on Github CI build can get the right version

astroboylrx · 2022-03-17T17:27:43Z

Yes it should be working now, but I am unsure if it needs to be built in a special way. You probably need to build JabRef from code on M1. I am not sure if the jpackage on Github CI build can get the right version

Thanks. Is there documentation to follow regarding how to build it on macOS?

Siedlerchr · 2022-03-17T17:39:21Z

To build the current version on Mac, you can just need JDK 17 https://adoptium.net/releases.html probably the aarch64 and Gradle.
then just do ./gradlew run to build and start the app for the first time.
You can also run ./gradlew jpackage . This will create the app under build/distribution
It will just show version 100 as default.

astroboylrx · 2022-03-18T02:34:04Z

@Siedlerchr Thank you sooo much!
I was able to build it successfully with the JDK 17 in your link (and with a few minor warnings warning: [module] module name component log4j2/ojdbc10/lang3/antlr4 should avoid terminal digits). It looks like jabref will download Gradle automatically after ./gradlew jpackage.

The about info shows

JabRef 100.0.0
Mac OS X 12.3 aarch64 
Java 17.0.2 
JavaFX 18+12

I guess I'll stick with version 100 before the official releases include arm builds 😄

astroboylrx · 2022-03-26T19:37:48Z

@Siedlerchr By the way, I'm happy to contribute my build to Development Builds if that's useful or helpful.

noirchen · 2022-03-27T09:28:58Z

@astroboylrx it would be great if you can share your builds.

astroboylrx · 2022-03-27T19:24:14Z

@astroboylrx it would be great if you can share your builds.

Sure, I created a repo and shared my builds in the Releases.

Siedlerchr · 2022-03-27T19:51:07Z

@astroboylrx Cool! Thanks. The only thing is that during our Github actions build we inject some token secrets for some fetchers.

astroboylrx · 2022-03-27T20:16:58Z

@astroboylrx Cool! Thanks. The only thing is that during our Github actions build we inject some token secrets for some fetchers.

I see. Thanks for the info! The main fetcher I'm using to add a new entry is "SAO/NASA ADS", "DOI", and "ArXiv", which all seem to be okay so far. I guess for those who need to use some specific fetchers, they may need to stick to the official builds to search for papers.

Emmm, I know the new API of SAO/NASA ADS requires a token and I've used that...
Oh, I see. Thanks for keeping some tokens in the repo.

Siedlerchr · 2022-03-27T20:20:17Z

We have some for testing in the repo and some secrets are injected into the build info.
And the other thing is just signing + notarizing for osx

jabref/.github/workflows/deployment.yml

Lines 22 to 24 in ee88e7f

    
           SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }} 
        
           AstrophysicsDataSystemAPIKey: ${{ secrets.AstrophysicsDataSystemAPIKey }} 
        
           IEEEAPIKey: ${{ secrets.IEEEAPIKey }}

liu-qilong · 2022-05-19T08:29:38Z

@astroboylrx it would be great if you can share your builds.

Sure, I created a repo and shared my builds in the Releases.

Thanks indeed! I tried it a little bit and it seems really smoother!

jangid19 · 2022-08-25T08:15:30Z

@astroboylrx it would be great if you can share your builds.

Sure, I created a repo and shared my builds in the Releases.

Thanks a lot. Feels great to be rocking JabRef 100.0.0. 😆

brodmo · 2022-10-04T13:10:24Z

Any updates on this? The .app I managed to build with ./gradlew jpackage doesn't work when using Java for ARM and I don't know why

Siedlerchr · 2022-10-04T15:10:56Z

@mbrdl Hi, unfortunately Github still does not offer ARM VMs for building on CI and I neither have an ARM machine. But mabye soon.
Did you install the correct JDK 18 for arm? Otherwise ask @jangid19

Siedlerchr · 2022-12-18T22:54:41Z

Good news at all, as I now have an M1 machine I was able to build the release packages for arm64 as well.
@JosephRedfern @jangid19 @mbrdl @astroboylrx

krantisaran · 2023-04-01T12:43:54Z

Any developments on how to get JabRef running on an M1? I managed to get it working on my desktop by installing it via brew, but no luck on my laptop.

Siedlerchr · 2023-04-01T12:50:08Z

@krantisaran The latest release is avaiable for m1 as well. works out of the box. We just had problems with the apple notraizatioh stuff, so ou have to execute xattr -d com.apple.quarantine /Applications/JabRef.app once

krantisaran · 2023-04-01T12:58:05Z

@Siedlerchr Thanks so much! We had a prior exchange on twitter but when I tried what you advised then I got an error message. Just installed jabref via brew and ran the command you mentioned and now it's working!! Thanks so much -- I've been stuck for months.

astroboylrx · 2023-04-10T21:25:08Z

To build the current version on Mac, you can just need JDK 17 https://adoptium.net/releases.html probably the aarch64 and Gradle. then just do ./gradlew run to build and start the app for the first time. You can also run ./gradlew jpackage . This will create the app under build/distribution It will just show version 100 as default.

Has anything changed for the compile procedure?
I have a Java Development Kit 19 and make JAVA_HOME pointing to this JDK. However, the build failed with:


> Configure project :
Project : => 'org.jabref' Java module

> Task :compileJava
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/Investigator.java:58: error: duplicate class: org.jabref.logic.importer.fileformat.medline.Investigator
public class Investigator {
       ^
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/MeshHeading.java:46: error: duplicate class: org.jabref.logic.importer.fileformat.medline.MeshHeading
public class MeshHeading {
       ^
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/ArticleId.java:41: error: duplicate class: org.jabref.logic.importer.fileformat.medline.ArticleId
public class ArticleId {
       ^
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/PersonalNameSubject.java:48: error: duplicate class: org.jabref.logic.importer.fileformat.medline.PersonalNameSubject
public class PersonalNameSubject {
       ^
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/ObjectFactory.java:416: error: constructor MeshHeading in record MeshHeading cannot be applied to given types;
        return new MeshHeading();
               ^
  required: String,List<String>
  found:    no arguments
  reason: actual and formal argument lists differ in length
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/ObjectFactory.java:448: error: constructor PersonalNameSubject in record PersonalNameSubject cannot be applied to given types;
        return new PersonalNameSubject();
               ^
  required: String,String
  found:    no arguments
  reason: actual and formal argument lists differ in length
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/ObjectFactory.java:496: error: constructor Investigator in record Investigator cannot be applied to given types;
        return new Investigator();
               ^
  required: String,String,List<String>
  found:    no arguments
  reason: actual and formal argument lists differ in length
/Users/rixin/opt/builds/jabref/src-gen/main/java/org/jabref/logic/importer/fileformat/medline/ObjectFactory.java:544: error: constructor ArticleId in record ArticleId cannot be applied to given types;
        return new ArticleId();
               ^
  required: String,String
  found:    no arguments
  reason: actual and formal argument lists differ in length
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
Note: Some input files use unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.
8 errors

> Task :compileJava FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileJava'.
> Compilation failed; see the compiler error output for details.

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.

* Get more help at https://help.gradle.org

Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

See https://docs.gradle.org/8.0.2/userguide/command_line_interface.html#sec:command_line_warnings

BUILD FAILED in 3s
10 actionable tasks: 2 executed, 8 up-to-date

Siedlerchr · 2023-04-11T05:19:05Z

Jdk 19 is sufficient. Just use a gradlew clean before. Then it should work

koppor · 2023-07-31T19:49:05Z

Notarization works again. Please wait for a release.

koppor · 2023-07-31T21:00:36Z

Fixed by #10095

eustomaqua · 2023-08-26T07:08:55Z

#7175 (comment)

Sorry to ask, but I installed JDK17 according to this illustration, trying to fix the issue of "JabRef runs and responds slowly on M1/M2". However, I cannot run "./gradlew run"

[~]$ ./gradlew run
zsh: no such file or directory: ./gradlew

May I ask what I should to do to fix it or adjust so that JabRef could respond more timely, please? Thanks

ThiloteE · 2023-08-26T07:44:26Z

That post is a little out of date. JabRef currently requires jdk 20 and for the next release, very likely a customized jdk 21 will be used that fixes "method too large" issues. So first install jdk20 and then try to use ./gradlew run or simply try the JabRef-5.10.dmg file from https://builds.jabref.org/main/, that I assume to also work for M1 now? - Is this correct @Siedlerchr?. Since this is a development version, please make sure to have a backup of your configuration/library file.

Siedlerchr · 2023-08-26T07:57:06Z

You can use this version https://builds.jabref.org/renameArm64/ (development version from a couple of days ago)
The next release is coming soon and will feature arm64.
building yourself is a bit more complicated due to our custom jdk

eustomaqua · 2023-08-26T08:03:58Z

#7175 (comment)

Thank you so much! It seems work well now after re-installing jdk 20 and jabref-5.10
Just for the record, ./gradlew run seems not work as well. But I directly downloaded "JabRef-5.10.dmg" and installed it. Now using JabRef is smoother than ever

[~]$ java -version
openjdk version "20.0.2" 2023-07-18
OpenJDK Runtime Environment Temurin-20.0.2+9 (build 20.0.2+9)
OpenJDK 64-Bit Server VM Temurin-20.0.2+9 (build 20.0.2+9, mixed mode)
[~]$ ./gradlew run
zsh: no such file or directory: ./gradlew

koppor · 2023-08-28T20:14:36Z

Will be part of the next release. Development builds available at https://builds.jabref.org/main/.

Siedlerchr added status: depends-on-external A bug or issue that depends on an update of an external library dev: build-system labels Dec 9, 2020

Siedlerchr mentioned this issue Jul 8, 2021

Creating a new library in JabRef 5.3 takes 6 seconds on macOS 11.4 #7893

Open

1 task

koppor moved this to Low priority in Features & Enhancements Nov 7, 2022

koppor added this to Features & Enhancements Nov 7, 2022

Siedlerchr moved this from Low priority to Normal priority in Features & Enhancements Dec 18, 2022

calixtus added this to the v5.10 milestone Apr 24, 2023

calixtus assigned Siedlerchr Jun 5, 2023

koppor removed the status: depends-on-external A bug or issue that depends on an update of an external library label Jul 31, 2023

koppor self-assigned this Jul 31, 2023

koppor closed this as completed Aug 28, 2023

github-project-automation bot moved this from Normal priority to Done in Features & Enhancements Aug 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Apple Silicon (macOS on ARM) #7175

Support for Apple Silicon (macOS on ARM) #7175

JosephRedfern commented Dec 9, 2020 •

edited

Loading

Siedlerchr commented Dec 9, 2020

Siedlerchr commented Mar 20, 2021

astroboylrx commented Mar 17, 2022

Siedlerchr commented Mar 17, 2022 •

edited

Loading

astroboylrx commented Mar 17, 2022

Siedlerchr commented Mar 17, 2022

astroboylrx commented Mar 18, 2022

astroboylrx commented Mar 26, 2022

noirchen commented Mar 27, 2022

astroboylrx commented Mar 27, 2022

Siedlerchr commented Mar 27, 2022

astroboylrx commented Mar 27, 2022

Siedlerchr commented Mar 27, 2022 •

edited

Loading

liu-qilong commented May 19, 2022

jangid19 commented Aug 25, 2022 •

edited

Loading

brodmo commented Oct 4, 2022 •

edited

Loading

Siedlerchr commented Oct 4, 2022

Siedlerchr commented Dec 18, 2022

krantisaran commented Apr 1, 2023

Siedlerchr commented Apr 1, 2023 •

edited

Loading

krantisaran commented Apr 1, 2023

astroboylrx commented Apr 10, 2023

Siedlerchr commented Apr 11, 2023

koppor commented Jul 31, 2023

koppor commented Jul 31, 2023

eustomaqua commented Aug 26, 2023

ThiloteE commented Aug 26, 2023 •

edited

Loading

Siedlerchr commented Aug 26, 2023

eustomaqua commented Aug 26, 2023

koppor commented Aug 28, 2023

Support for Apple Silicon (macOS on ARM) #7175

Support for Apple Silicon (macOS on ARM) #7175

Comments

JosephRedfern commented Dec 9, 2020 • edited Loading

Siedlerchr commented Dec 9, 2020

Siedlerchr commented Mar 20, 2021

astroboylrx commented Mar 17, 2022

Siedlerchr commented Mar 17, 2022 • edited Loading

astroboylrx commented Mar 17, 2022

Siedlerchr commented Mar 17, 2022

astroboylrx commented Mar 18, 2022

astroboylrx commented Mar 26, 2022

noirchen commented Mar 27, 2022

astroboylrx commented Mar 27, 2022

Siedlerchr commented Mar 27, 2022

astroboylrx commented Mar 27, 2022

Siedlerchr commented Mar 27, 2022 • edited Loading

liu-qilong commented May 19, 2022

jangid19 commented Aug 25, 2022 • edited Loading

brodmo commented Oct 4, 2022 • edited Loading

Siedlerchr commented Oct 4, 2022

Siedlerchr commented Dec 18, 2022

krantisaran commented Apr 1, 2023

Siedlerchr commented Apr 1, 2023 • edited Loading

krantisaran commented Apr 1, 2023

astroboylrx commented Apr 10, 2023

Siedlerchr commented Apr 11, 2023

koppor commented Jul 31, 2023

koppor commented Jul 31, 2023

eustomaqua commented Aug 26, 2023

ThiloteE commented Aug 26, 2023 • edited Loading

Siedlerchr commented Aug 26, 2023

eustomaqua commented Aug 26, 2023

koppor commented Aug 28, 2023

JosephRedfern commented Dec 9, 2020 •

edited

Loading

Siedlerchr commented Mar 17, 2022 •

edited

Loading

Siedlerchr commented Mar 27, 2022 •

edited

Loading

jangid19 commented Aug 25, 2022 •

edited

Loading

brodmo commented Oct 4, 2022 •

edited

Loading

Siedlerchr commented Apr 1, 2023 •

edited

Loading

ThiloteE commented Aug 26, 2023 •

edited

Loading